d23e64abaa06b4c1d3327f4bedd638e52dd5cf64
[notmuch] / lib / message.cc
1 /* message.cc - Results of message-based searches from a notmuch database
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 "notmuch-private.h"
22 #include "database-private.h"
23 #include "message-private.h"
24
25 #include <stdint.h>
26
27 #include <gmime/gmime.h>
28
29 struct _notmuch_message {
30     notmuch_database_t *notmuch;
31     Xapian::docid doc_id;
32     int frozen;
33     char *message_id;
34     char *thread_id;
35     size_t thread_depth;
36     char *in_reply_to;
37     notmuch_string_list_t *tag_list;
38     notmuch_string_list_t *filename_term_list;
39     notmuch_string_list_t *filename_list;
40     char *maildir_flags;
41     char *author;
42     notmuch_message_file_t *message_file;
43     notmuch_string_list_t *property_term_list;
44     notmuch_string_map_t *property_map;
45     notmuch_string_list_t *reference_list;
46     notmuch_message_list_t *replies;
47     unsigned long flags;
48     /* For flags that are initialized on-demand, lazy_flags indicates
49      * if each flag has been initialized. */
50     unsigned long lazy_flags;
51
52     /* Message document modified since last sync */
53     bool modified;
54
55     /* last view of database the struct is synced with */
56     unsigned long last_view;
57
58     Xapian::Document doc;
59     Xapian::termcount termpos;
60 };
61
62 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
63
64 struct maildir_flag_tag {
65     char flag;
66     const char *tag;
67     bool inverse;
68 };
69
70 /* ASCII ordered table of Maildir flags and associated tags */
71 static struct maildir_flag_tag flag2tag[] = {
72     { 'D', "draft",   false },
73     { 'F', "flagged", false },
74     { 'P', "passed",  false },
75     { 'R', "replied", false },
76     { 'S', "unread",  true }
77 };
78
79 /* We end up having to call the destructor explicitly because we had
80  * to use "placement new" in order to initialize C++ objects within a
81  * block that we allocated with talloc. So C++ is making talloc
82  * slightly less simple to use, (we wouldn't need
83  * talloc_set_destructor at all otherwise).
84  */
85 static int
86 _notmuch_message_destructor (notmuch_message_t *message)
87 {
88     message->doc.~Document ();
89
90     return 0;
91 }
92
93 #define LOG_XAPIAN_EXCEPTION(message, error) _log_xapian_exception (__location__, message, error)
94
95 static void
96 _log_xapian_exception (const char *where, notmuch_message_t *message,  const Xapian::Error error) {
97     notmuch_database_t *notmuch = notmuch_message_get_database (message);
98     _notmuch_database_log (notmuch,
99                            "A Xapian exception occurred at %s: %s\n",
100                            where,
101                            error.get_msg ().c_str ());
102     notmuch->exception_reported = true;
103 }
104
105 static notmuch_message_t *
106 _notmuch_message_create_for_document (const void *talloc_owner,
107                                       notmuch_database_t *notmuch,
108                                       unsigned int doc_id,
109                                       Xapian::Document doc,
110                                       notmuch_private_status_t *status)
111 {
112     notmuch_message_t *message;
113
114     if (status)
115         *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
116
117     message = talloc (talloc_owner, notmuch_message_t);
118     if (unlikely (message == NULL)) {
119         if (status)
120             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
121         return NULL;
122     }
123
124     message->notmuch = notmuch;
125     message->doc_id = doc_id;
126
127     message->frozen = 0;
128     message->flags = 0;
129     message->lazy_flags = 0;
130
131     /* the message is initially not synchronized with Xapian */
132     message->last_view = 0;
133
134     /* Calculated after the thread structure is computed */
135     message->thread_depth = 0;
136
137     /* Each of these will be lazily created as needed. */
138     message->message_id = NULL;
139     message->thread_id = NULL;
140     message->in_reply_to = NULL;
141     message->tag_list = NULL;
142     message->filename_term_list = NULL;
143     message->filename_list = NULL;
144     message->maildir_flags = NULL;
145     message->message_file = NULL;
146     message->author = NULL;
147     message->property_term_list = NULL;
148     message->property_map = NULL;
149     message->reference_list = NULL;
150
151     message->replies = _notmuch_message_list_create (message);
152     if (unlikely (message->replies == NULL)) {
153         if (status)
154             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
155         return NULL;
156     }
157
158     /* This is C++'s creepy "placement new", which is really just an
159      * ugly way to call a constructor for a pre-allocated object. So
160      * it's really not an error to not be checking for OUT_OF_MEMORY
161      * here, since this "new" isn't actually allocating memory. This
162      * is language-design comedy of the wrong kind. */
163
164     new (&message->doc) Xapian::Document;
165
166     talloc_set_destructor (message, _notmuch_message_destructor);
167
168     message->doc = doc;
169     message->termpos = 0;
170
171     return message;
172 }
173
174 /* Create a new notmuch_message_t object for an existing document in
175  * the database.
176  *
177  * Here, 'talloc owner' is an optional talloc context to which the new
178  * message will belong. This allows for the caller to not bother
179  * calling notmuch_message_destroy on the message, and know that all
180  * memory will be reclaimed when 'talloc_owner' is freed. The caller
181  * still can call notmuch_message_destroy when finished with the
182  * message if desired.
183  *
184  * The 'talloc_owner' argument can also be NULL, in which case the
185  * caller *is* responsible for calling notmuch_message_destroy.
186  *
187  * If no document exists in the database with document ID of 'doc_id'
188  * then this function returns NULL and optionally sets *status to
189  * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
190  *
191  * This function can also fail to due lack of available memory,
192  * returning NULL and optionally setting *status to
193  * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
194  *
195  * The caller can pass NULL for status if uninterested in
196  * distinguishing these two cases.
197  */
198 notmuch_message_t *
199 _notmuch_message_create (const void *talloc_owner,
200                          notmuch_database_t *notmuch,
201                          unsigned int doc_id,
202                          notmuch_private_status_t *status)
203 {
204     Xapian::Document doc;
205
206     try {
207         doc = notmuch->xapian_db->get_document (doc_id);
208     } catch (const Xapian::DocNotFoundError &error) {
209         if (status)
210             *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
211         return NULL;
212     }
213
214     return _notmuch_message_create_for_document (talloc_owner, notmuch,
215                                                  doc_id, doc, status);
216 }
217
218 /* Create a new notmuch_message_t object for a specific message ID,
219  * (which may or may not already exist in the database).
220  *
221  * The 'notmuch' database will be the talloc owner of the returned
222  * message.
223  *
224  * This function returns a valid notmuch_message_t whether or not
225  * there is already a document in the database with the given message
226  * ID. These two cases can be distinguished by the value of *status:
227  *
228  *
229  *   NOTMUCH_PRIVATE_STATUS_SUCCESS:
230  *
231  *     There is already a document with message ID 'message_id' in the
232  *     database. The returned message can be used to query/modify the
233  *     document. The message may be a ghost message.
234  *
235  *   NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:
236  *
237  *     No document with 'message_id' exists in the database. The
238  *     returned message contains a newly created document (not yet
239  *     added to the database) and a document ID that is known not to
240  *     exist in the database.  This message is "blank"; that is, it
241  *     contains only a message ID and no other metadata. The caller
242  *     can modify the message, and a call to _notmuch_message_sync
243  *     will add the document to the database.
244  *
245  * If an error occurs, this function will return NULL and *status
246  * will be set as appropriate. (The status pointer argument must
247  * not be NULL.)
248  */
249 notmuch_message_t *
250 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
251                                         const char *message_id,
252                                         notmuch_private_status_t *status_ret)
253 {
254     notmuch_message_t *message;
255     Xapian::Document doc;
256     unsigned int doc_id;
257     char *term;
258
259     *status_ret = (notmuch_private_status_t) notmuch_database_find_message (notmuch,
260                                                                             message_id,
261                                                                             &message);
262     if (message)
263         return talloc_steal (notmuch, message);
264     else if (*status_ret)
265         return NULL;
266
267     /* If the message ID is too long, substitute its sha1 instead. */
268     if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
269         message_id = _notmuch_message_id_compressed (message, message_id);
270
271     term = talloc_asprintf (NULL, "%s%s",
272                             _find_prefix ("id"), message_id);
273     if (term == NULL) {
274         *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
275         return NULL;
276     }
277
278     if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY)
279         INTERNAL_ERROR ("Failure to ensure database is writable.");
280
281     try {
282         doc.add_term (term, 0);
283         talloc_free (term);
284
285         doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
286
287         doc_id = _notmuch_database_generate_doc_id (notmuch);
288     } catch (const Xapian::Error &error) {
289         _notmuch_database_log (notmuch_message_get_database (message), "A Xapian exception occurred creating message: %s\n",
290                                error.get_msg ().c_str ());
291         notmuch->exception_reported = true;
292         *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
293         return NULL;
294     }
295
296     message = _notmuch_message_create_for_document (notmuch, notmuch,
297                                                     doc_id, doc, status_ret);
298
299     /* We want to inform the caller that we had to create a new
300      * document. */
301     if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
302         *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
303
304     return message;
305 }
306
307 static char *
308 _notmuch_message_get_term (notmuch_message_t *message,
309                            Xapian::TermIterator &i, Xapian::TermIterator &end,
310                            const char *prefix)
311 {
312     int prefix_len = strlen (prefix);
313     char *value;
314
315     i.skip_to (prefix);
316
317     if (i == end)
318         return NULL;
319
320     const std::string &term = *i;
321     if (strncmp (term.c_str (), prefix, prefix_len))
322         return NULL;
323
324     value = talloc_strdup (message, term.c_str () + prefix_len);
325
326 #if DEBUG_DATABASE_SANITY
327     i++;
328
329     if (i != end && strncmp ((*i).c_str (), prefix, prefix_len) == 0) {
330         INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate %s terms: %s and %s\n",
331                         message->doc_id, prefix, value,
332                         (*i).c_str () + prefix_len);
333     }
334 #endif
335
336     return value;
337 }
338
339 /*
340  * For special applications where we only want the thread id, reading
341  * in all metadata is a heavy I/O penalty.
342  */
343 const char *
344 _notmuch_message_get_thread_id_only (notmuch_message_t *message)
345 {
346
347     Xapian::TermIterator i = message->doc.termlist_begin ();
348     Xapian::TermIterator end = message->doc.termlist_end ();
349
350     message->thread_id = _notmuch_message_get_term (message, i, end,
351                                                     _find_prefix ("thread"));
352     return message->thread_id;
353 }
354
355
356 static void
357 _notmuch_message_ensure_metadata (notmuch_message_t *message, void *field)
358 {
359     Xapian::TermIterator i, end;
360
361     if (field && (message->last_view >= message->notmuch->view))
362         return;
363
364     const char *thread_prefix = _find_prefix ("thread"),
365                *tag_prefix = _find_prefix ("tag"),
366                *id_prefix = _find_prefix ("id"),
367                *type_prefix = _find_prefix ("type"),
368                *filename_prefix = _find_prefix ("file-direntry"),
369                *property_prefix = _find_prefix ("property"),
370                *reference_prefix = _find_prefix ("reference"),
371                *replyto_prefix = _find_prefix ("replyto");
372
373     /* We do this all in a single pass because Xapian decompresses the
374      * term list every time you iterate over it.  Thus, while this is
375      * slightly more costly than looking up individual fields if only
376      * one field of the message object is actually used, it's a huge
377      * win as more fields are used. */
378     for (int count = 0; count < 3; count++) {
379         try {
380             i = message->doc.termlist_begin ();
381             end = message->doc.termlist_end ();
382
383             /* Get thread */
384             if (! message->thread_id)
385                 message->thread_id =
386                     _notmuch_message_get_term (message, i, end, thread_prefix);
387
388             /* Get tags */
389             assert (strcmp (thread_prefix, tag_prefix) < 0);
390             if (! message->tag_list) {
391                 message->tag_list =
392                     _notmuch_database_get_terms_with_prefix (message, i, end,
393                                                              tag_prefix);
394                 _notmuch_string_list_sort (message->tag_list);
395             }
396
397             /* Get id */
398             assert (strcmp (tag_prefix, id_prefix) < 0);
399             if (! message->message_id)
400                 message->message_id =
401                     _notmuch_message_get_term (message, i, end, id_prefix);
402
403             /* Get document type */
404             assert (strcmp (id_prefix, type_prefix) < 0);
405             if (! NOTMUCH_TEST_BIT (message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST)) {
406                 i.skip_to (type_prefix);
407                 /* "T" is the prefix "type" fields.  See
408                  * BOOLEAN_PREFIX_INTERNAL. */
409                 if (*i == "Tmail")
410                     NOTMUCH_CLEAR_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
411                 else if (*i == "Tghost")
412                     NOTMUCH_SET_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
413                 else
414                     INTERNAL_ERROR ("Message without type term");
415                 NOTMUCH_SET_BIT (&message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST);
416             }
417
418             /* Get filename list.  Here we get only the terms.  We lazily
419              * expand them to full file names when needed in
420              * _notmuch_message_ensure_filename_list. */
421             assert (strcmp (type_prefix, filename_prefix) < 0);
422             if (! message->filename_term_list && ! message->filename_list)
423                 message->filename_term_list =
424                     _notmuch_database_get_terms_with_prefix (message, i, end,
425                                                              filename_prefix);
426
427
428             /* Get property terms. Mimic the setup with filenames above */
429             assert (strcmp (filename_prefix, property_prefix) < 0);
430             if (! message->property_map && ! message->property_term_list)
431                 message->property_term_list =
432                     _notmuch_database_get_terms_with_prefix (message, i, end,
433                                                              property_prefix);
434
435             /* get references */
436             assert (strcmp (property_prefix, reference_prefix) < 0);
437             if (! message->reference_list) {
438                 message->reference_list =
439                     _notmuch_database_get_terms_with_prefix (message, i, end,
440                                                              reference_prefix);
441             }
442
443             /* Get reply to */
444             assert (strcmp (property_prefix, replyto_prefix) < 0);
445             if (! message->in_reply_to)
446                 message->in_reply_to =
447                     _notmuch_message_get_term (message, i, end, replyto_prefix);
448
449
450             /* It's perfectly valid for a message to have no In-Reply-To
451              * header. For these cases, we return an empty string. */
452             if (! message->in_reply_to)
453                 message->in_reply_to = talloc_strdup (message, "");
454
455             /* all the way without an exception */
456             break;
457         } catch (const Xapian::DatabaseModifiedError &error) {
458             notmuch_status_t status = _notmuch_database_reopen (message->notmuch);
459             if (status != NOTMUCH_STATUS_SUCCESS)
460                 INTERNAL_ERROR ("unhandled error from notmuch_database_reopen: %s\n",
461                                 notmuch_status_to_string (status));
462         }
463     }
464     message->last_view = message->notmuch->view;
465 }
466
467 void
468 _notmuch_message_invalidate_metadata (notmuch_message_t *message,
469                                       const char *prefix_name)
470 {
471     if (strcmp ("thread", prefix_name) == 0) {
472         talloc_free (message->thread_id);
473         message->thread_id = NULL;
474     }
475
476     if (strcmp ("tag", prefix_name) == 0) {
477         talloc_unlink (message, message->tag_list);
478         message->tag_list = NULL;
479     }
480
481     if (strcmp ("type", prefix_name) == 0) {
482         NOTMUCH_CLEAR_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
483         NOTMUCH_CLEAR_BIT (&message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST);
484     }
485
486     if (strcmp ("file-direntry", prefix_name) == 0) {
487         talloc_free (message->filename_term_list);
488         talloc_free (message->filename_list);
489         message->filename_term_list = message->filename_list = NULL;
490     }
491
492     if (strcmp ("property", prefix_name) == 0) {
493
494         if (message->property_term_list)
495             talloc_free (message->property_term_list);
496         message->property_term_list = NULL;
497
498         if (message->property_map)
499             talloc_unlink (message, message->property_map);
500
501         message->property_map = NULL;
502     }
503
504     if (strcmp ("replyto", prefix_name) == 0) {
505         talloc_free (message->in_reply_to);
506         message->in_reply_to = NULL;
507     }
508 }
509
510 unsigned int
511 _notmuch_message_get_doc_id (notmuch_message_t *message)
512 {
513     return message->doc_id;
514 }
515
516 const char *
517 notmuch_message_get_message_id (notmuch_message_t *message)
518 {
519     try {
520         _notmuch_message_ensure_metadata (message, message->message_id);
521     } catch (const Xapian::Error &error) {
522         LOG_XAPIAN_EXCEPTION (message, error);
523         return NULL;
524     }
525
526     if (! message->message_id)
527         INTERNAL_ERROR ("Message with document ID of %u has no message ID.\n",
528                         message->doc_id);
529     return message->message_id;
530 }
531
532 static void
533 _notmuch_message_ensure_message_file (notmuch_message_t *message)
534 {
535     const char *filename;
536
537     if (message->message_file)
538         return;
539
540     filename = notmuch_message_get_filename (message);
541     if (unlikely (filename == NULL))
542         return;
543
544     message->message_file = _notmuch_message_file_open_ctx (
545         notmuch_message_get_database (message), message, filename);
546 }
547
548 const char *
549 notmuch_message_get_header (notmuch_message_t *message, const char *header)
550 {
551     Xapian::valueno slot = Xapian::BAD_VALUENO;
552
553     /* Fetch header from the appropriate xapian value field if
554      * available */
555     if (strcasecmp (header, "from") == 0)
556         slot = NOTMUCH_VALUE_FROM;
557     else if (strcasecmp (header, "subject") == 0)
558         slot = NOTMUCH_VALUE_SUBJECT;
559     else if (strcasecmp (header, "message-id") == 0)
560         slot = NOTMUCH_VALUE_MESSAGE_ID;
561
562     if (slot != Xapian::BAD_VALUENO) {
563         try {
564             std::string value = message->doc.get_value (slot);
565
566             /* If we have NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES, then
567              * empty values indicate empty headers.  If we don't, then
568              * it could just mean we didn't record the header. */
569             if ((message->notmuch->features &
570                  NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES) ||
571                 ! value.empty ())
572                 return talloc_strdup (message, value.c_str ());
573
574         } catch (Xapian::Error &error) {
575             LOG_XAPIAN_EXCEPTION (message, error);
576             return NULL;
577         }
578     }
579
580     /* Otherwise fall back to parsing the file */
581     _notmuch_message_ensure_message_file (message);
582     if (message->message_file == NULL)
583         return NULL;
584
585     return _notmuch_message_file_get_header (message->message_file, header);
586 }
587
588 /* Return the message ID from the In-Reply-To header of 'message'.
589  *
590  * Returns an empty string ("") if 'message' has no In-Reply-To
591  * header.
592  *
593  * Returns NULL if any error occurs.
594  */
595 const char *
596 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
597 {
598     _notmuch_message_ensure_metadata (message, message->in_reply_to);
599     return message->in_reply_to;
600 }
601
602 const char *
603 notmuch_message_get_thread_id (notmuch_message_t *message)
604 {
605     try {
606         _notmuch_message_ensure_metadata (message, message->thread_id);
607     } catch (Xapian::Error &error) {
608         LOG_XAPIAN_EXCEPTION (message, error);
609         return NULL;
610     }
611     if (! message->thread_id)
612         INTERNAL_ERROR ("Message with document ID of %u has no thread ID.\n",
613                         message->doc_id);
614     return message->thread_id;
615 }
616
617 void
618 _notmuch_message_add_reply (notmuch_message_t *message,
619                             notmuch_message_t *reply)
620 {
621     _notmuch_message_list_add_message (message->replies, reply);
622 }
623
624 size_t
625 _notmuch_message_get_thread_depth (notmuch_message_t *message)
626 {
627     return message->thread_depth;
628 }
629
630 void
631 _notmuch_message_label_depths (notmuch_message_t *message,
632                                size_t depth)
633 {
634     message->thread_depth = depth;
635
636     for (notmuch_messages_t *messages = _notmuch_messages_create (message->replies);
637          notmuch_messages_valid (messages);
638          notmuch_messages_move_to_next (messages)) {
639         notmuch_message_t *child = notmuch_messages_get (messages);
640         _notmuch_message_label_depths (child, depth + 1);
641     }
642 }
643
644 const notmuch_string_list_t *
645 _notmuch_message_get_references (notmuch_message_t *message)
646 {
647     _notmuch_message_ensure_metadata (message, message->reference_list);
648     return message->reference_list;
649 }
650
651 static int
652 _cmpmsg (const void *pa, const void *pb)
653 {
654     notmuch_message_t **a = (notmuch_message_t **) pa;
655     notmuch_message_t **b = (notmuch_message_t **) pb;
656     time_t time_a = notmuch_message_get_date (*a);
657     time_t time_b = notmuch_message_get_date (*b);
658
659     if (time_a == time_b)
660         return 0;
661     else if (time_a < time_b)
662         return -1;
663     else
664         return 1;
665 }
666
667 notmuch_message_list_t *
668 _notmuch_message_sort_subtrees (void *ctx, notmuch_message_list_t *list)
669 {
670
671     size_t count = 0;
672     size_t capacity = 16;
673
674     if (! list)
675         return list;
676
677     void *local = talloc_new (NULL);
678     notmuch_message_list_t *new_list = _notmuch_message_list_create (ctx);
679     notmuch_message_t **message_array = talloc_zero_array (local, notmuch_message_t *, capacity);
680
681     for (notmuch_messages_t *messages = _notmuch_messages_create (list);
682          notmuch_messages_valid (messages);
683          notmuch_messages_move_to_next (messages)) {
684         notmuch_message_t *root = notmuch_messages_get (messages);
685         if (count >= capacity) {
686             capacity *= 2;
687             message_array = talloc_realloc (local, message_array, notmuch_message_t *, capacity);
688         }
689         message_array[count++] = root;
690         root->replies = _notmuch_message_sort_subtrees (root, root->replies);
691     }
692
693     qsort (message_array, count, sizeof (notmuch_message_t *), _cmpmsg);
694     for (size_t i = 0; i < count; i++) {
695         _notmuch_message_list_add_message (new_list, message_array[i]);
696     }
697
698     talloc_free (local);
699     talloc_free (list);
700     return new_list;
701 }
702
703 notmuch_messages_t *
704 notmuch_message_get_replies (notmuch_message_t *message)
705 {
706     return _notmuch_messages_create (message->replies);
707 }
708
709 void
710 _notmuch_message_remove_terms (notmuch_message_t *message, const char *prefix)
711 {
712     Xapian::TermIterator i;
713     size_t prefix_len = 0;
714
715     prefix_len = strlen (prefix);
716
717     while (1) {
718         i = message->doc.termlist_begin ();
719         i.skip_to (prefix);
720
721         /* Terminate loop when no terms remain with desired prefix. */
722         if (i == message->doc.termlist_end () ||
723             strncmp ((*i).c_str (), prefix, prefix_len))
724             break;
725
726         try {
727             message->doc.remove_term ((*i));
728             message->modified = true;
729         } catch (const Xapian::InvalidArgumentError) {
730             /* Ignore failure to remove non-existent term. */
731         }
732     }
733 }
734
735
736 /* Remove all terms generated by indexing, i.e. not tags or
737  * properties, along with any automatic tags*/
738 /* According to Xapian API docs, none of these calls throw
739  * exceptions */
740 notmuch_private_status_t
741 _notmuch_message_remove_indexed_terms (notmuch_message_t *message)
742 {
743     Xapian::TermIterator i;
744
745     const std::string
746         id_prefix = _find_prefix ("id"),
747         property_prefix = _find_prefix ("property"),
748         tag_prefix = _find_prefix ("tag"),
749         type_prefix = _find_prefix ("type");
750
751     /* Make sure we have the data to restore to Xapian*/
752     _notmuch_message_ensure_metadata (message, NULL);
753
754     /* Empirically, it turns out to be faster to remove all the terms,
755      * and add back the ones we want. */
756     message->doc.clear_terms ();
757     message->modified = true;
758
759     /* still a mail message */
760     message->doc.add_term (type_prefix + "mail");
761
762     /* Put back message-id */
763     message->doc.add_term (id_prefix + message->message_id);
764
765     /* Put back non-automatic tags */
766     for (notmuch_tags_t *tags = notmuch_message_get_tags (message);
767          notmuch_tags_valid (tags);
768          notmuch_tags_move_to_next (tags)) {
769
770         const char *tag = notmuch_tags_get (tags);
771
772         if (strcmp (tag, "encrypted") != 0 &&
773             strcmp (tag, "signed") != 0 &&
774             strcmp (tag, "attachment") != 0) {
775             std::string term = tag_prefix + tag;
776             message->doc.add_term (term);
777         }
778     }
779
780     /* Put back properties */
781     notmuch_message_properties_t *list;
782
783     for (list = notmuch_message_get_properties (message, "", false);
784          notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
785         std::string term = property_prefix +
786                            notmuch_message_properties_key (list) + "=" +
787                            notmuch_message_properties_value (list);
788
789         message->doc.add_term (term);
790     }
791
792     notmuch_message_properties_destroy (list);
793
794     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
795 }
796
797
798 /* Return true if p points at "new" or "cur". */
799 static bool
800 is_maildir (const char *p)
801 {
802     return strcmp (p, "cur") == 0 || strcmp (p, "new") == 0;
803 }
804
805 /* Add "folder:" term for directory. */
806 static notmuch_status_t
807 _notmuch_message_add_folder_terms (notmuch_message_t *message,
808                                    const char *directory)
809 {
810     char *folder, *last;
811
812     folder = talloc_strdup (NULL, directory);
813     if (! folder)
814         return NOTMUCH_STATUS_OUT_OF_MEMORY;
815
816     /*
817      * If the message file is in a leaf directory named "new" or
818      * "cur", presume maildir and index the parent directory. Thus a
819      * "folder:" prefix search matches messages in the specified
820      * maildir folder, i.e. in the specified directory and its "new"
821      * and "cur" subdirectories.
822      *
823      * Note that this means the "folder:" prefix can't be used for
824      * distinguishing between message files in "new" or "cur". The
825      * "path:" prefix needs to be used for that.
826      *
827      * Note the deliberate difference to _filename_is_in_maildir(). We
828      * don't want to index different things depending on the existence
829      * or non-existence of all maildir sibling directories "new",
830      * "cur", and "tmp". Doing so would be surprising, and difficult
831      * for the user to fix in case all subdirectories were not in
832      * place during indexing.
833      */
834     last = strrchr (folder, '/');
835     if (last) {
836         if (is_maildir (last + 1))
837             *last = '\0';
838     } else if (is_maildir (folder)) {
839         *folder = '\0';
840     }
841
842     _notmuch_message_add_term (message, "folder", folder);
843
844     talloc_free (folder);
845
846     message->modified = true;
847     return NOTMUCH_STATUS_SUCCESS;
848 }
849
850 #define RECURSIVE_SUFFIX "/**"
851
852 /* Add "path:" terms for directory. */
853 static notmuch_status_t
854 _notmuch_message_add_path_terms (notmuch_message_t *message,
855                                  const char *directory)
856 {
857     /* Add exact "path:" term. */
858     _notmuch_message_add_term (message, "path", directory);
859
860     if (strlen (directory)) {
861         char *path, *p;
862
863         path = talloc_asprintf (NULL, "%s%s", directory, RECURSIVE_SUFFIX);
864         if (! path)
865             return NOTMUCH_STATUS_OUT_OF_MEMORY;
866
867         /* Add recursive "path:" terms for directory and all parents. */
868         for (p = path + strlen (path) - 1; p > path; p--) {
869             if (*p == '/') {
870                 strcpy (p, RECURSIVE_SUFFIX);
871                 _notmuch_message_add_term (message, "path", path);
872             }
873         }
874
875         talloc_free (path);
876     }
877
878     /* Recursive all-matching path:** for consistency. */
879     _notmuch_message_add_term (message, "path", "**");
880
881     return NOTMUCH_STATUS_SUCCESS;
882 }
883
884 /* Add directory based terms for all filenames of the message. */
885 static notmuch_status_t
886 _notmuch_message_add_directory_terms (void *ctx, notmuch_message_t *message)
887 {
888     const char *direntry_prefix = _find_prefix ("file-direntry");
889     int direntry_prefix_len = strlen (direntry_prefix);
890     Xapian::TermIterator i = message->doc.termlist_begin ();
891     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
892
893     for (i.skip_to (direntry_prefix); i != message->doc.termlist_end (); i++) {
894         unsigned int directory_id;
895         const char *direntry, *directory;
896         char *colon;
897         const std::string &term = *i;
898
899         /* Terminate loop at first term without desired prefix. */
900         if (strncmp (term.c_str (), direntry_prefix, direntry_prefix_len))
901             break;
902
903         /* Indicate that there are filenames remaining. */
904         status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
905
906         direntry = term.c_str ();
907         direntry += direntry_prefix_len;
908
909         directory_id = strtol (direntry, &colon, 10);
910
911         if (colon == NULL || *colon != ':')
912             INTERNAL_ERROR ("malformed direntry");
913
914         directory = _notmuch_database_get_directory_path (ctx,
915                                                           message->notmuch,
916                                                           directory_id);
917
918         _notmuch_message_add_folder_terms (message, directory);
919         _notmuch_message_add_path_terms (message, directory);
920     }
921
922     return status;
923 }
924
925 /* Add an additional 'filename' for 'message'.
926  *
927  * This change will not be reflected in the database until the next
928  * call to _notmuch_message_sync. */
929 notmuch_status_t
930 _notmuch_message_add_filename (notmuch_message_t *message,
931                                const char *filename)
932 {
933     const char *relative, *directory;
934     notmuch_status_t status;
935     void *local = talloc_new (message);
936     char *direntry;
937
938     if (filename == NULL)
939         INTERNAL_ERROR ("Message filename cannot be NULL.");
940
941     if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
942         ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
943         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
944
945     relative = _notmuch_database_relative_path (message->notmuch, filename);
946
947     status = _notmuch_database_split_path (local, relative, &directory, NULL);
948     if (status)
949         return status;
950
951     status = _notmuch_database_filename_to_direntry (
952         local, message->notmuch, filename, NOTMUCH_FIND_CREATE, &direntry);
953     if (status)
954         return status;
955
956     /* New file-direntry allows navigating to this message with
957      * notmuch_directory_get_child_files() . */
958     _notmuch_message_add_term (message, "file-direntry", direntry);
959
960     _notmuch_message_add_folder_terms (message, directory);
961     _notmuch_message_add_path_terms (message, directory);
962
963     talloc_free (local);
964
965     return NOTMUCH_STATUS_SUCCESS;
966 }
967
968 /* Remove a particular 'filename' from 'message'.
969  *
970  * This change will not be reflected in the database until the next
971  * call to _notmuch_message_sync.
972  *
973  * If this message still has other filenames, returns
974  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
975  *
976  * Note: This function does not remove a document from the database,
977  * even if the specified filename is the only filename for this
978  * message. For that functionality, see
979  * notmuch_database_remove_message. */
980 notmuch_status_t
981 _notmuch_message_remove_filename (notmuch_message_t *message,
982                                   const char *filename)
983 {
984     void *local = talloc_new (message);
985     char *direntry;
986     notmuch_private_status_t private_status;
987     notmuch_status_t status;
988
989     if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
990         ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
991         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
992
993     status = _notmuch_database_filename_to_direntry (
994         local, message->notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
995     if (status || ! direntry)
996         return status;
997
998     /* Unlink this file from its parent directory. */
999     private_status = _notmuch_message_remove_term (message,
1000                                                    "file-direntry", direntry);
1001     status = COERCE_STATUS (private_status,
1002                             "Unexpected error from _notmuch_message_remove_term");
1003     if (status)
1004         return status;
1005
1006     /* Re-synchronize "folder:" and "path:" terms for this message. */
1007
1008     /* Remove all "folder:" terms. */
1009     _notmuch_message_remove_terms (message, _find_prefix ("folder"));
1010
1011     /* Remove all "path:" terms. */
1012     _notmuch_message_remove_terms (message, _find_prefix ("path"));
1013
1014     /* Add back terms for all remaining filenames of the message. */
1015     status = _notmuch_message_add_directory_terms (local, message);
1016
1017     talloc_free (local);
1018
1019     return status;
1020 }
1021
1022 /* Upgrade the "folder:" prefix from V1 to V2. */
1023 #define FOLDER_PREFIX_V1       "XFOLDER"
1024 #define ZFOLDER_PREFIX_V1      "Z" FOLDER_PREFIX_V1
1025 void
1026 _notmuch_message_upgrade_folder (notmuch_message_t *message)
1027 {
1028     /* Remove all old "folder:" terms. */
1029     _notmuch_message_remove_terms (message, FOLDER_PREFIX_V1);
1030
1031     /* Remove all old "folder:" stemmed terms. */
1032     _notmuch_message_remove_terms (message, ZFOLDER_PREFIX_V1);
1033
1034     /* Add new boolean "folder:" and "path:" terms. */
1035     _notmuch_message_add_directory_terms (message, message);
1036 }
1037
1038 char *
1039 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
1040 {
1041     return talloc_strdup (message, message->doc.get_data ().c_str ());
1042 }
1043
1044 void
1045 _notmuch_message_clear_data (notmuch_message_t *message)
1046 {
1047     message->doc.set_data ("");
1048     message->modified = true;
1049 }
1050
1051 static void
1052 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
1053 {
1054     notmuch_string_node_t *node;
1055
1056     if (message->filename_list)
1057         return;
1058
1059     _notmuch_message_ensure_metadata (message, message->filename_term_list);
1060
1061     message->filename_list = _notmuch_string_list_create (message);
1062     node = message->filename_term_list->head;
1063
1064     if (! node) {
1065         /* A message document created by an old version of notmuch
1066          * (prior to rename support) will have the filename in the
1067          * data of the document rather than as a file-direntry term.
1068          *
1069          * It would be nice to do the upgrade of the document directly
1070          * here, but the database is likely open in read-only mode. */
1071
1072         std::string datastr = message->doc.get_data ();
1073         const char *data = datastr.c_str ();
1074
1075         if (data == NULL)
1076             INTERNAL_ERROR ("message with no filename");
1077
1078         _notmuch_string_list_append (message->filename_list, data);
1079
1080         return;
1081     }
1082
1083     for (; node; node = node->next) {
1084         void *local = talloc_new (message);
1085         const char *db_path, *directory, *basename, *filename;
1086         char *colon, *direntry = NULL;
1087         unsigned int directory_id;
1088
1089         direntry = node->string;
1090
1091         directory_id = strtol (direntry, &colon, 10);
1092
1093         if (colon == NULL || *colon != ':')
1094             INTERNAL_ERROR ("malformed direntry");
1095
1096         basename = colon + 1;
1097
1098         *colon = '\0';
1099
1100         db_path = notmuch_database_get_path (message->notmuch);
1101
1102         directory = _notmuch_database_get_directory_path (local,
1103                                                           message->notmuch,
1104                                                           directory_id);
1105
1106         if (strlen (directory))
1107             filename = talloc_asprintf (message, "%s/%s/%s",
1108                                         db_path, directory, basename);
1109         else
1110             filename = talloc_asprintf (message, "%s/%s",
1111                                         db_path, basename);
1112
1113         _notmuch_string_list_append (message->filename_list, filename);
1114
1115         talloc_free (local);
1116     }
1117
1118     talloc_free (message->filename_term_list);
1119     message->filename_term_list = NULL;
1120 }
1121
1122 const char *
1123 notmuch_message_get_filename (notmuch_message_t *message)
1124 {
1125     try {
1126         _notmuch_message_ensure_filename_list (message);
1127     } catch (Xapian::Error &error) {
1128         LOG_XAPIAN_EXCEPTION (message, error);
1129         return NULL;
1130     }
1131
1132     if (message->filename_list == NULL)
1133         return NULL;
1134
1135     if (message->filename_list->head == NULL ||
1136         message->filename_list->head->string == NULL) {
1137         INTERNAL_ERROR ("message with no filename");
1138     }
1139
1140     return message->filename_list->head->string;
1141 }
1142
1143 notmuch_filenames_t *
1144 notmuch_message_get_filenames (notmuch_message_t *message)
1145 {
1146     try {
1147         _notmuch_message_ensure_filename_list (message);
1148     } catch (Xapian::Error &error) {
1149         LOG_XAPIAN_EXCEPTION (message, error);
1150         return NULL;
1151     }
1152
1153     return _notmuch_filenames_create (message, message->filename_list);
1154 }
1155
1156 int
1157 notmuch_message_count_files (notmuch_message_t *message)
1158 {
1159     try {
1160         _notmuch_message_ensure_filename_list (message);
1161     } catch (Xapian::Error &error) {
1162         LOG_XAPIAN_EXCEPTION (message, error);
1163         return -1;
1164     }
1165
1166     return _notmuch_string_list_length (message->filename_list);
1167 }
1168
1169 notmuch_status_t
1170 notmuch_message_get_flag_st (notmuch_message_t *message,
1171                              notmuch_message_flag_t flag,
1172                              notmuch_bool_t *is_set)
1173 {
1174     if (! is_set)
1175         return NOTMUCH_STATUS_NULL_POINTER;
1176
1177     try {
1178         if (flag == NOTMUCH_MESSAGE_FLAG_GHOST &&
1179             ! NOTMUCH_TEST_BIT (message->lazy_flags, flag))
1180             _notmuch_message_ensure_metadata (message, NULL);
1181     } catch (Xapian::Error &error) {
1182         LOG_XAPIAN_EXCEPTION (message, error);
1183         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1184     }
1185
1186     *is_set = NOTMUCH_TEST_BIT (message->flags, flag);
1187     return NOTMUCH_STATUS_SUCCESS;
1188 }
1189
1190 notmuch_bool_t
1191 notmuch_message_get_flag (notmuch_message_t *message,
1192                           notmuch_message_flag_t flag)
1193 {
1194     notmuch_bool_t is_set;
1195     notmuch_status_t status;
1196
1197     status = notmuch_message_get_flag_st (message, flag, &is_set);
1198
1199     if (status)
1200         return FALSE;
1201     else
1202         return is_set;
1203 }
1204
1205 void
1206 notmuch_message_set_flag (notmuch_message_t *message,
1207                           notmuch_message_flag_t flag, notmuch_bool_t enable)
1208 {
1209     if (enable)
1210         NOTMUCH_SET_BIT (&message->flags, flag);
1211     else
1212         NOTMUCH_CLEAR_BIT (&message->flags, flag);
1213     NOTMUCH_SET_BIT (&message->lazy_flags, flag);
1214 }
1215
1216 time_t
1217 notmuch_message_get_date (notmuch_message_t *message)
1218 {
1219     std::string value;
1220
1221     try {
1222         value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
1223     } catch (Xapian::Error &error) {
1224         LOG_XAPIAN_EXCEPTION (message, error);
1225         return 0;
1226     }
1227
1228     if (value.empty ())
1229         /* sortable_unserialise is undefined on empty string */
1230         return 0;
1231     return Xapian::sortable_unserialise (value);
1232 }
1233
1234 notmuch_tags_t *
1235 notmuch_message_get_tags (notmuch_message_t *message)
1236 {
1237     notmuch_tags_t *tags;
1238
1239     try {
1240         _notmuch_message_ensure_metadata (message, message->tag_list);
1241     } catch (Xapian::Error &error) {
1242         LOG_XAPIAN_EXCEPTION (message, error);
1243         return NULL;
1244     }
1245
1246     tags = _notmuch_tags_create (message, message->tag_list);
1247     /* _notmuch_tags_create steals the reference to the tag_list, but
1248      * in this case it's still used by the message, so we add an
1249      * *additional* talloc reference to the list.  As a result, it's
1250      * possible to modify the message tags (which talloc_unlink's the
1251      * current list from the message) while still iterating because
1252      * the iterator will keep the current list alive. */
1253     if (! talloc_reference (message, message->tag_list))
1254         return NULL;
1255
1256     return tags;
1257 }
1258
1259 const char *
1260 _notmuch_message_get_author (notmuch_message_t *message)
1261 {
1262     return message->author;
1263 }
1264
1265 void
1266 _notmuch_message_set_author (notmuch_message_t *message,
1267                              const char *author)
1268 {
1269     if (message->author)
1270         talloc_free (message->author);
1271     message->author = talloc_strdup (message, author);
1272     return;
1273 }
1274
1275 void
1276 _notmuch_message_set_header_values (notmuch_message_t *message,
1277                                     const char *date,
1278                                     const char *from,
1279                                     const char *subject)
1280 {
1281     time_t time_value;
1282
1283     /* GMime really doesn't want to see a NULL date, so protect its
1284      * sensibilities. */
1285     if (date == NULL || *date == '\0') {
1286         time_value = 0;
1287     } else {
1288         time_value = g_mime_utils_header_decode_date_unix (date);
1289         /*
1290          * Workaround for https://bugzilla.gnome.org/show_bug.cgi?id=779923
1291          */
1292         if (time_value < 0)
1293             time_value = 0;
1294     }
1295
1296     message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
1297                             Xapian::sortable_serialise (time_value));
1298     message->doc.add_value (NOTMUCH_VALUE_FROM, from);
1299     message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
1300     message->modified = true;
1301 }
1302
1303 void
1304 _notmuch_message_update_subject (notmuch_message_t *message,
1305                                  const char *subject)
1306 {
1307     message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
1308     message->modified = true;
1309 }
1310
1311 /* Upgrade a message to support NOTMUCH_FEATURE_LAST_MOD.  The caller
1312  * must call _notmuch_message_sync. */
1313 void
1314 _notmuch_message_upgrade_last_mod (notmuch_message_t *message)
1315 {
1316     /* _notmuch_message_sync will update the last modification
1317      * revision; we just have to ask it to. */
1318     message->modified = true;
1319 }
1320
1321 /* Synchronize changes made to message->doc out into the database. */
1322 void
1323 _notmuch_message_sync (notmuch_message_t *message)
1324 {
1325     Xapian::WritableDatabase *db;
1326
1327     if (_notmuch_database_mode (message->notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY)
1328         return;
1329
1330     if (! message->modified)
1331         return;
1332
1333     /* Update the last modification of this message. */
1334     if (message->notmuch->features & NOTMUCH_FEATURE_LAST_MOD)
1335         /* sortable_serialise gives a reasonably compact encoding,
1336          * which directly translates to reduced IO when scanning the
1337          * value stream.  Since it's built for doubles, we only get 53
1338          * effective bits, but that's still enough for the database to
1339          * last a few centuries at 1 million revisions per second. */
1340         message->doc.add_value (NOTMUCH_VALUE_LAST_MOD,
1341                                 Xapian::sortable_serialise (
1342                                     _notmuch_database_new_revision (
1343                                         message->notmuch)));
1344
1345     db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
1346     db->replace_document (message->doc_id, message->doc);
1347     message->modified = false;
1348 }
1349
1350 /* Delete a message document from the database, leaving a ghost
1351  * message in its place */
1352 notmuch_status_t
1353 _notmuch_message_delete (notmuch_message_t *message)
1354 {
1355     notmuch_status_t status;
1356     Xapian::WritableDatabase *db;
1357     const char *mid, *tid, *query_string;
1358     notmuch_message_t *ghost;
1359     notmuch_private_status_t private_status;
1360     notmuch_database_t *notmuch;
1361     notmuch_query_t *query;
1362     unsigned int count = 0;
1363     bool is_ghost;
1364
1365     mid = notmuch_message_get_message_id (message);
1366     tid = notmuch_message_get_thread_id (message);
1367     notmuch = message->notmuch;
1368
1369     status = _notmuch_database_ensure_writable (message->notmuch);
1370     if (status)
1371         return status;
1372
1373     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1374     db->delete_document (message->doc_id);
1375
1376     /* if this was a ghost to begin with, we are done */
1377     private_status = _notmuch_message_has_term (message, "type", "ghost", &is_ghost);
1378     if (private_status)
1379         return COERCE_STATUS (private_status,
1380                               "Error trying to determine whether message was a ghost");
1381     if (is_ghost)
1382         return NOTMUCH_STATUS_SUCCESS;
1383
1384     query_string = talloc_asprintf (message, "thread:%s", tid);
1385     query = notmuch_query_create (notmuch, query_string);
1386     if (query == NULL)
1387         return NOTMUCH_STATUS_OUT_OF_MEMORY;
1388     status = notmuch_query_count_messages (query, &count);
1389     if (status) {
1390         notmuch_query_destroy (query);
1391         return status;
1392     }
1393
1394     if (count > 0) {
1395         /* reintroduce a ghost in its place because there are still
1396          * other active messages in this thread: */
1397         ghost = _notmuch_message_create_for_message_id (notmuch, mid, &private_status);
1398         if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1399             private_status = _notmuch_message_initialize_ghost (ghost, tid);
1400             if (! private_status)
1401                 _notmuch_message_sync (ghost);
1402         } else if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1403             /* this is deeply weird, and we should not have gotten
1404              * into this state.  is there a better error message to
1405              * return here? */
1406             status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1407         }
1408
1409         notmuch_message_destroy (ghost);
1410         status = COERCE_STATUS (private_status, "Error converting to ghost message");
1411     } else {
1412         /* the thread is empty; drop all ghost messages from it */
1413         notmuch_messages_t *messages;
1414         status = _notmuch_query_search_documents (query,
1415                                                   "ghost",
1416                                                   &messages);
1417         if (status == NOTMUCH_STATUS_SUCCESS) {
1418             notmuch_status_t last_error = NOTMUCH_STATUS_SUCCESS;
1419             while (notmuch_messages_valid (messages)) {
1420                 message = notmuch_messages_get (messages);
1421                 status = _notmuch_message_delete (message);
1422                 if (status) /* we'll report the last failure we see;
1423                                          * if there is more than one failure, we
1424                                          * forget about previous ones */
1425                     last_error = status;
1426                 notmuch_message_destroy (message);
1427                 notmuch_messages_move_to_next (messages);
1428             }
1429             status = last_error;
1430         }
1431     }
1432     notmuch_query_destroy (query);
1433     return status;
1434 }
1435
1436 /* Transform a blank message into a ghost message.  The caller must
1437  * _notmuch_message_sync the message. */
1438 notmuch_private_status_t
1439 _notmuch_message_initialize_ghost (notmuch_message_t *message,
1440                                    const char *thread_id)
1441 {
1442     notmuch_private_status_t status;
1443
1444     status = _notmuch_message_add_term (message, "type", "ghost");
1445     if (status)
1446         return status;
1447     status = _notmuch_message_add_term (message, "thread", thread_id);
1448     if (status)
1449         return status;
1450
1451     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1452 }
1453
1454 /* Ensure that 'message' is not holding any file object open. Future
1455  * calls to various functions will still automatically open the
1456  * message file as needed.
1457  */
1458 void
1459 _notmuch_message_close (notmuch_message_t *message)
1460 {
1461     if (message->message_file) {
1462         _notmuch_message_file_close (message->message_file);
1463         message->message_file = NULL;
1464     }
1465 }
1466
1467 /* Add a name:value term to 'message', (the actual term will be
1468  * encoded by prefixing the value with a short prefix). See
1469  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1470  * names to prefix values.
1471  *
1472  * This change will not be reflected in the database until the next
1473  * call to _notmuch_message_sync. */
1474 notmuch_private_status_t
1475 _notmuch_message_add_term (notmuch_message_t *message,
1476                            const char *prefix_name,
1477                            const char *value)
1478 {
1479
1480     char *term;
1481
1482     if (value == NULL)
1483         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1484
1485     term = talloc_asprintf (message, "%s%s",
1486                             _find_prefix (prefix_name), value);
1487
1488     if (strlen (term) > NOTMUCH_TERM_MAX)
1489         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1490
1491     message->doc.add_term (term, 0);
1492     message->modified = true;
1493
1494     talloc_free (term);
1495
1496     _notmuch_message_invalidate_metadata (message, prefix_name);
1497
1498     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1499 }
1500
1501 /* Parse 'text' and add a term to 'message' for each parsed word. Each
1502  * term will be added with the appropriate prefix if prefix_name is
1503  * non-NULL.
1504  */
1505 notmuch_private_status_t
1506 _notmuch_message_gen_terms (notmuch_message_t *message,
1507                             const char *prefix_name,
1508                             const char *text)
1509 {
1510     Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
1511
1512     if (text == NULL)
1513         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1514
1515     term_gen->set_document (message->doc);
1516     term_gen->set_termpos (message->termpos);
1517
1518     if (prefix_name) {
1519         const char *prefix = _notmuch_database_prefix (message->notmuch, prefix_name);
1520         if (prefix == NULL)
1521             return NOTMUCH_PRIVATE_STATUS_BAD_PREFIX;
1522
1523         _notmuch_message_invalidate_metadata (message, prefix_name);
1524         term_gen->index_text (text, 1, prefix);
1525     } else {
1526         term_gen->index_text (text);
1527     }
1528
1529     /* Create a gap between this an the next terms so they don't
1530      * appear to be a phrase. */
1531     message->termpos = term_gen->get_termpos () + 100;
1532
1533     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1534 }
1535
1536 /* Remove a name:value term from 'message', (the actual term will be
1537  * encoded by prefixing the value with a short prefix). See
1538  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1539  * names to prefix values.
1540  *
1541  * This change will not be reflected in the database until the next
1542  * call to _notmuch_message_sync. */
1543 notmuch_private_status_t
1544 _notmuch_message_remove_term (notmuch_message_t *message,
1545                               const char *prefix_name,
1546                               const char *value)
1547 {
1548     char *term;
1549
1550     if (value == NULL)
1551         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1552
1553     term = talloc_asprintf (message, "%s%s",
1554                             _find_prefix (prefix_name), value);
1555
1556     if (strlen (term) > NOTMUCH_TERM_MAX)
1557         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1558
1559     try {
1560         message->doc.remove_term (term);
1561         message->modified = true;
1562     } catch (const Xapian::InvalidArgumentError) {
1563         /* We'll let the philosophers try to wrestle with the
1564          * question of whether failing to remove that which was not
1565          * there in the first place is failure. For us, we'll silently
1566          * consider it all good. */
1567     }
1568
1569     talloc_free (term);
1570
1571     _notmuch_message_invalidate_metadata (message, prefix_name);
1572
1573     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1574 }
1575
1576 notmuch_private_status_t
1577 _notmuch_message_has_term (notmuch_message_t *message,
1578                            const char *prefix_name,
1579                            const char *value,
1580                            bool *result)
1581 {
1582     char *term;
1583     bool out = false;
1584     notmuch_private_status_t status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
1585
1586     if (value == NULL)
1587         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1588
1589     term = talloc_asprintf (message, "%s%s",
1590                             _find_prefix (prefix_name), value);
1591
1592     if (strlen (term) > NOTMUCH_TERM_MAX)
1593         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1594
1595     try {
1596         /* Look for the exact term */
1597         Xapian::TermIterator i = message->doc.termlist_begin ();
1598         i.skip_to (term);
1599         if (i != message->doc.termlist_end () &&
1600             ! strcmp ((*i).c_str (), term))
1601             out = true;
1602     } catch (Xapian::Error &error) {
1603         status = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
1604     }
1605     talloc_free (term);
1606
1607     *result = out;
1608     return status;
1609 }
1610
1611 notmuch_status_t
1612 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
1613 {
1614     notmuch_private_status_t private_status;
1615     notmuch_status_t status;
1616
1617     try {
1618         status = _notmuch_database_ensure_writable (message->notmuch);
1619         if (status)
1620             return status;
1621
1622         if (tag == NULL)
1623             return NOTMUCH_STATUS_NULL_POINTER;
1624
1625         if (strlen (tag) > NOTMUCH_TAG_MAX)
1626             return NOTMUCH_STATUS_TAG_TOO_LONG;
1627
1628         private_status = _notmuch_message_add_term (message, "tag", tag);
1629         if (private_status) {
1630             return COERCE_STATUS (private_status,
1631                                   "_notmuch_message_remove_term return unexpected value: %d\n",
1632                                   private_status);
1633         }
1634
1635         if (! message->frozen)
1636             _notmuch_message_sync (message);
1637
1638     } catch (Xapian::Error &error) {
1639         LOG_XAPIAN_EXCEPTION (message, error);
1640         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1641     }
1642
1643     return NOTMUCH_STATUS_SUCCESS;
1644 }
1645
1646 notmuch_status_t
1647 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
1648 {
1649     notmuch_private_status_t private_status;
1650     notmuch_status_t status;
1651
1652     try {
1653         status = _notmuch_database_ensure_writable (message->notmuch);
1654         if (status)
1655             return status;
1656
1657         if (tag == NULL)
1658             return NOTMUCH_STATUS_NULL_POINTER;
1659
1660         if (strlen (tag) > NOTMUCH_TAG_MAX)
1661             return NOTMUCH_STATUS_TAG_TOO_LONG;
1662
1663         private_status = _notmuch_message_remove_term (message, "tag", tag);
1664         if (private_status) {
1665             return COERCE_STATUS (private_status,
1666                                   "_notmuch_message_remove_term return unexpected value: %d\n",
1667                                   private_status);
1668         }
1669
1670         if (! message->frozen)
1671             _notmuch_message_sync (message);
1672     } catch (Xapian::Error &error) {
1673         LOG_XAPIAN_EXCEPTION (message, error);
1674         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1675     }
1676
1677     return NOTMUCH_STATUS_SUCCESS;
1678 }
1679
1680 /* Is the given filename within a maildir directory?
1681  *
1682  * Specifically, is the final directory component of 'filename' either
1683  * "cur" or "new". If so, return a pointer to that final directory
1684  * component within 'filename'. If not, return NULL.
1685  *
1686  * A non-NULL return value is guaranteed to be a valid string pointer
1687  * pointing to the characters "new/" or "cur/", (but not
1688  * NUL-terminated).
1689  */
1690 static const char *
1691 _filename_is_in_maildir (const char *filename)
1692 {
1693     const char *slash, *dir = NULL;
1694
1695     /* Find the last '/' separating directory from filename. */
1696     slash = strrchr (filename, '/');
1697     if (slash == NULL)
1698         return NULL;
1699
1700     /* Jump back 4 characters to where the previous '/' will be if the
1701      * directory is named "cur" or "new". */
1702     if (slash - filename < 4)
1703         return NULL;
1704
1705     slash -= 4;
1706
1707     if (*slash != '/')
1708         return NULL;
1709
1710     dir = slash + 1;
1711
1712     if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1713         STRNCMP_LITERAL (dir, "new/") == 0) {
1714         return dir;
1715     }
1716
1717     return NULL;
1718 }
1719
1720 static notmuch_status_t
1721 _ensure_maildir_flags (notmuch_message_t *message, bool force)
1722 {
1723     const char *flags;
1724     notmuch_filenames_t *filenames;
1725     const char *filename, *dir;
1726     char *combined_flags = talloc_strdup (message, "");
1727     int seen_maildir_info = 0;
1728
1729     if (message->maildir_flags) {
1730         if (force) {
1731             talloc_free (message->maildir_flags);
1732             message->maildir_flags = NULL;
1733         }
1734     }
1735     filenames = notmuch_message_get_filenames (message);
1736     if (! filenames)
1737         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1738     for (;
1739          notmuch_filenames_valid (filenames);
1740          notmuch_filenames_move_to_next (filenames)) {
1741         filename = notmuch_filenames_get (filenames);
1742         dir = _filename_is_in_maildir (filename);
1743
1744         if (! dir)
1745             continue;
1746
1747         flags = strstr (filename, ":2,");
1748         if (flags) {
1749             seen_maildir_info = 1;
1750             flags += 3;
1751             combined_flags = talloc_strdup_append (combined_flags, flags);
1752         } else if (STRNCMP_LITERAL (dir, "new/") == 0) {
1753             /* Messages are delivered to new/ with no "info" part, but
1754              * they effectively have default maildir flags.  According
1755              * to the spec, we should ignore the info part for
1756              * messages in new/, but some MUAs (mutt) can set maildir
1757              * flags on messages in new/, so we're liberal in what we
1758              * accept. */
1759             seen_maildir_info = 1;
1760         }
1761     }
1762     if (seen_maildir_info)
1763         message->maildir_flags = combined_flags;
1764     return NOTMUCH_STATUS_SUCCESS;
1765 }
1766
1767 notmuch_bool_t
1768 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag)
1769 {
1770     notmuch_status_t status;
1771     notmuch_bool_t ret;
1772     status = notmuch_message_has_maildir_flag_st (message, flag, &ret);
1773     if (status)
1774         return FALSE;
1775
1776     return ret;
1777 }
1778
1779 notmuch_status_t
1780 notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
1781                                      char flag,
1782                                      notmuch_bool_t *is_set)
1783 {
1784     notmuch_status_t status;
1785     
1786     if (! is_set)
1787         return NOTMUCH_STATUS_NULL_POINTER;
1788
1789     status = _ensure_maildir_flags (message, false);
1790     if (status)
1791         return status;
1792     
1793     *is_set =  message->maildir_flags && (strchr (message->maildir_flags, flag) != NULL);
1794     return NOTMUCH_STATUS_SUCCESS;
1795 }
1796
1797 notmuch_status_t
1798 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1799 {
1800     notmuch_status_t status;
1801     unsigned i;
1802
1803     status = _ensure_maildir_flags (message, true);
1804     if (status)
1805         return status;
1806     /* If none of the filenames have any maildir info field (not even
1807      * an empty info with no flags set) then there's no information to
1808      * go on, so do nothing. */
1809     if (! message->maildir_flags)
1810         return NOTMUCH_STATUS_SUCCESS;
1811
1812     status = notmuch_message_freeze (message);
1813     if (status)
1814         return status;
1815
1816     for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1817         if ((strchr (message->maildir_flags, flag2tag[i].flag) != NULL)
1818             ^
1819             flag2tag[i].inverse) {
1820             status = notmuch_message_add_tag (message, flag2tag[i].tag);
1821         } else {
1822             status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1823         }
1824         if (status)
1825             return status;
1826     }
1827     status = notmuch_message_thaw (message);
1828
1829     return status;
1830 }
1831
1832 /* From the set of tags on 'message' and the flag2tag table, compute a
1833  * set of maildir-flag actions to be taken, (flags that should be
1834  * either set or cleared).
1835  *
1836  * The result is returned as two talloced strings: to_set, and to_clear
1837  */
1838 static void
1839 _get_maildir_flag_actions (notmuch_message_t *message,
1840                            char **to_set_ret,
1841                            char **to_clear_ret)
1842 {
1843     char *to_set, *to_clear;
1844     notmuch_tags_t *tags;
1845     const char *tag;
1846     unsigned i;
1847
1848     to_set = talloc_strdup (message, "");
1849     to_clear = talloc_strdup (message, "");
1850
1851     /* First, find flags for all set tags. */
1852     for (tags = notmuch_message_get_tags (message);
1853          notmuch_tags_valid (tags);
1854          notmuch_tags_move_to_next (tags)) {
1855         tag = notmuch_tags_get (tags);
1856
1857         for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1858             if (strcmp (tag, flag2tag[i].tag) == 0) {
1859                 if (flag2tag[i].inverse)
1860                     to_clear = talloc_asprintf_append (to_clear,
1861                                                        "%c",
1862                                                        flag2tag[i].flag);
1863                 else
1864                     to_set = talloc_asprintf_append (to_set,
1865                                                      "%c",
1866                                                      flag2tag[i].flag);
1867             }
1868         }
1869     }
1870
1871     /* Then, find the flags for all tags not present. */
1872     for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1873         if (flag2tag[i].inverse) {
1874             if (strchr (to_clear, flag2tag[i].flag) == NULL)
1875                 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1876         } else {
1877             if (strchr (to_set, flag2tag[i].flag) == NULL)
1878                 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1879         }
1880     }
1881
1882     *to_set_ret = to_set;
1883     *to_clear_ret = to_clear;
1884 }
1885
1886 /* Given 'filename' and a set of maildir flags to set and to clear,
1887  * compute the new maildir filename.
1888  *
1889  * If the existing filename is in the directory "new", the new
1890  * filename will be in the directory "cur", except for the case when
1891  * no flags are changed and the existing filename does not contain
1892  * maildir info (starting with ",2:").
1893  *
1894  * After a sequence of ":2," in the filename, any subsequent
1895  * single-character flags will be added or removed according to the
1896  * characters in flags_to_set and flags_to_clear. Any existing flags
1897  * not mentioned in either string will remain. The final list of flags
1898  * will be in ASCII order.
1899  *
1900  * If the original flags seem invalid, (repeated characters or
1901  * non-ASCII ordering of flags), this function will return NULL
1902  * (meaning that renaming would not be safe and should not occur).
1903  */
1904 static char *
1905 _new_maildir_filename (void *ctx,
1906                        const char *filename,
1907                        const char *flags_to_set,
1908                        const char *flags_to_clear)
1909 {
1910     const char *info, *flags;
1911     unsigned int flag, last_flag;
1912     char *filename_new, *dir;
1913     char flag_map[128];
1914     int flags_in_map = 0;
1915     bool flags_changed = false;
1916     unsigned int i;
1917     char *s;
1918
1919     memset (flag_map, 0, sizeof (flag_map));
1920
1921     info = strstr (filename, ":2,");
1922
1923     if (info == NULL) {
1924         info = filename + strlen (filename);
1925     } else {
1926         /* Loop through existing flags in filename. */
1927         for (flags = info + 3, last_flag = 0;
1928              *flags;
1929              last_flag = flag, flags++) {
1930             flag = *flags;
1931
1932             /* Original flags not in ASCII order. Abort. */
1933             if (flag < last_flag)
1934                 return NULL;
1935
1936             /* Non-ASCII flag. Abort. */
1937             if (flag > sizeof (flag_map) - 1)
1938                 return NULL;
1939
1940             /* Repeated flag value. Abort. */
1941             if (flag_map[flag])
1942                 return NULL;
1943
1944             flag_map[flag] = 1;
1945             flags_in_map++;
1946         }
1947     }
1948
1949     /* Then set and clear our flags from tags. */
1950     for (flags = flags_to_set; *flags; flags++) {
1951         flag = *flags;
1952         if (flag_map[flag] == 0) {
1953             flag_map[flag] = 1;
1954             flags_in_map++;
1955             flags_changed = true;
1956         }
1957     }
1958
1959     for (flags = flags_to_clear; *flags; flags++) {
1960         flag = *flags;
1961         if (flag_map[flag]) {
1962             flag_map[flag] = 0;
1963             flags_in_map--;
1964             flags_changed = true;
1965         }
1966     }
1967
1968     /* Messages in new/ without maildir info can be kept in new/ if no
1969      * flags have changed. */
1970     dir = (char *) _filename_is_in_maildir (filename);
1971     if (dir && STRNCMP_LITERAL (dir, "new/") == 0 && ! *info && ! flags_changed)
1972         return talloc_strdup (ctx, filename);
1973
1974     filename_new = (char *) talloc_size (ctx,
1975                                          info - filename +
1976                                          strlen (":2,") + flags_in_map + 1);
1977     if (unlikely (filename_new == NULL))
1978         return NULL;
1979
1980     strncpy (filename_new, filename, info - filename);
1981     filename_new[info - filename] = '\0';
1982
1983     strcat (filename_new, ":2,");
1984
1985     s = filename_new + strlen (filename_new);
1986     for (i = 0; i < sizeof (flag_map); i++) {
1987         if (flag_map[i]) {
1988             *s = i;
1989             s++;
1990         }
1991     }
1992     *s = '\0';
1993
1994     /* If message is in new/ move it under cur/. */
1995     dir = (char *) _filename_is_in_maildir (filename_new);
1996     if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1997         memcpy (dir, "cur/", 4);
1998
1999     return filename_new;
2000 }
2001
2002 notmuch_status_t
2003 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
2004 {
2005     notmuch_filenames_t *filenames;
2006     const char *filename;
2007     char *filename_new;
2008     char *to_set, *to_clear;
2009     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
2010
2011     _get_maildir_flag_actions (message, &to_set, &to_clear);
2012
2013     for (filenames = notmuch_message_get_filenames (message);
2014          notmuch_filenames_valid (filenames);
2015          notmuch_filenames_move_to_next (filenames)) {
2016         filename = notmuch_filenames_get (filenames);
2017
2018         if (! _filename_is_in_maildir (filename))
2019             continue;
2020
2021         filename_new = _new_maildir_filename (message, filename,
2022                                               to_set, to_clear);
2023         if (filename_new == NULL)
2024             continue;
2025
2026         if (strcmp (filename, filename_new)) {
2027             int err;
2028             notmuch_status_t new_status;
2029
2030             err = rename (filename, filename_new);
2031             if (err)
2032                 continue;
2033
2034             new_status = _notmuch_message_remove_filename (message,
2035                                                            filename);
2036             /* Hold on to only the first error. */
2037             if (! status && new_status
2038                 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
2039                 status = new_status;
2040                 continue;
2041             }
2042
2043             new_status = _notmuch_message_add_filename (message,
2044                                                         filename_new);
2045             /* Hold on to only the first error. */
2046             if (! status && new_status) {
2047                 status = new_status;
2048                 continue;
2049             }
2050
2051             _notmuch_message_sync (message);
2052         }
2053
2054         talloc_free (filename_new);
2055     }
2056
2057     talloc_free (to_set);
2058     talloc_free (to_clear);
2059
2060     return status;
2061 }
2062
2063 notmuch_status_t
2064 notmuch_message_remove_all_tags (notmuch_message_t *message)
2065 {
2066     notmuch_private_status_t private_status;
2067     notmuch_status_t status;
2068     notmuch_tags_t *tags;
2069     const char *tag;
2070
2071     status = _notmuch_database_ensure_writable (message->notmuch);
2072     if (status)
2073         return status;
2074     tags = notmuch_message_get_tags (message);
2075     if (! tags)
2076         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2077
2078     for (;
2079          notmuch_tags_valid (tags);
2080          notmuch_tags_move_to_next (tags)) {
2081         tag = notmuch_tags_get (tags);
2082
2083         private_status = _notmuch_message_remove_term (message, "tag", tag);
2084         if (private_status) {
2085             return COERCE_STATUS (private_status,
2086                                    "_notmuch_message_remove_term return unexpected value: %d\n",
2087                                    private_status);
2088         }
2089     }
2090
2091     if (! message->frozen)
2092         _notmuch_message_sync (message);
2093
2094     talloc_free (tags);
2095     return NOTMUCH_STATUS_SUCCESS;
2096 }
2097
2098 notmuch_status_t
2099 notmuch_message_freeze (notmuch_message_t *message)
2100 {
2101     notmuch_status_t status;
2102
2103     status = _notmuch_database_ensure_writable (message->notmuch);
2104     if (status)
2105         return status;
2106
2107     message->frozen++;
2108
2109     return NOTMUCH_STATUS_SUCCESS;
2110 }
2111
2112 notmuch_status_t
2113 notmuch_message_thaw (notmuch_message_t *message)
2114 {
2115     notmuch_status_t status;
2116
2117     status = _notmuch_database_ensure_writable (message->notmuch);
2118     if (status)
2119         return status;
2120
2121     if (message->frozen > 0) {
2122         message->frozen--;
2123         if (message->frozen == 0)
2124             _notmuch_message_sync (message);
2125         return NOTMUCH_STATUS_SUCCESS;
2126     } else {
2127         return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
2128     }
2129 }
2130
2131 void
2132 notmuch_message_destroy (notmuch_message_t *message)
2133 {
2134     talloc_free (message);
2135 }
2136
2137 notmuch_database_t *
2138 notmuch_message_get_database (const notmuch_message_t *message)
2139 {
2140     return message->notmuch;
2141 }
2142
2143 static void
2144 _notmuch_message_ensure_property_map (notmuch_message_t *message)
2145 {
2146     notmuch_string_node_t *node;
2147
2148     if (message->property_map)
2149         return;
2150
2151     _notmuch_message_ensure_metadata (message, message->property_term_list);
2152
2153     message->property_map = _notmuch_string_map_create (message);
2154
2155     for (node = message->property_term_list->head; node; node = node->next) {
2156         const char *key;
2157         char *value;
2158
2159         value = strchr (node->string, '=');
2160         if (! value)
2161             INTERNAL_ERROR ("malformed property term");
2162
2163         *value = '\0';
2164         value++;
2165         key = node->string;
2166
2167         _notmuch_string_map_append (message->property_map, key, value);
2168
2169     }
2170
2171     talloc_free (message->property_term_list);
2172     message->property_term_list = NULL;
2173 }
2174
2175 notmuch_string_map_t *
2176 _notmuch_message_property_map (notmuch_message_t *message)
2177 {
2178     _notmuch_message_ensure_property_map (message);
2179
2180     return message->property_map;
2181 }
2182
2183 bool
2184 _notmuch_message_frozen (notmuch_message_t *message)
2185 {
2186     return message->frozen;
2187 }
2188
2189 notmuch_status_t
2190 notmuch_message_reindex (notmuch_message_t *message,
2191                          notmuch_indexopts_t *indexopts)
2192 {
2193     notmuch_database_t *notmuch = NULL;
2194     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2195     notmuch_private_status_t private_status;
2196     notmuch_filenames_t *orig_filenames = NULL;
2197     const char *orig_thread_id = NULL;
2198     notmuch_message_file_t *message_file = NULL;
2199
2200     int found = 0;
2201
2202     if (message == NULL)
2203         return NOTMUCH_STATUS_NULL_POINTER;
2204
2205     /* Save in case we need to delete message */
2206     orig_thread_id = notmuch_message_get_thread_id (message);
2207     if (! orig_thread_id) {
2208         /* the following is correct as long as there is only one reason
2209            n_m_get_thread_id returns NULL
2210         */
2211         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2212     }
2213
2214     /* strdup it because the metadata may be invalidated */
2215     orig_thread_id = talloc_strdup (message, orig_thread_id);
2216
2217     notmuch = notmuch_message_get_database (message);
2218
2219     ret = _notmuch_database_ensure_writable (notmuch);
2220     if (ret)
2221         return ret;
2222
2223     orig_filenames = notmuch_message_get_filenames (message);
2224
2225     private_status = _notmuch_message_remove_indexed_terms (message);
2226     if (private_status) {
2227         ret = COERCE_STATUS (private_status, "error removing terms");
2228         goto DONE;
2229     }
2230
2231     ret = notmuch_message_remove_all_properties_with_prefix (message, "index.");
2232     if (ret)
2233         goto DONE; /* XXX TODO: distinguish from other error returns above? */
2234     if (indexopts && notmuch_indexopts_get_decrypt_policy (indexopts) == NOTMUCH_DECRYPT_FALSE) {
2235         ret = notmuch_message_remove_all_properties (message, "session-key");
2236         if (ret)
2237             goto DONE;
2238     }
2239
2240     /* re-add the filenames with the associated indexopts */
2241     for (; notmuch_filenames_valid (orig_filenames);
2242          notmuch_filenames_move_to_next (orig_filenames)) {
2243
2244         const char *date;
2245         const char *from, *to, *subject;
2246         char *message_id = NULL;
2247         const char *thread_id = NULL;
2248
2249         const char *filename = notmuch_filenames_get (orig_filenames);
2250
2251         message_file = _notmuch_message_file_open (notmuch, filename);
2252         if (message_file == NULL)
2253             continue;
2254
2255         ret = _notmuch_message_file_get_headers (message_file,
2256                                                  &from, &subject, &to, &date,
2257                                                  &message_id);
2258         if (ret)
2259             goto DONE;
2260
2261         /* XXX TODO: deal with changing message id? */
2262
2263         _notmuch_message_add_filename (message, filename);
2264
2265         ret = _notmuch_database_link_message_to_parents (notmuch, message,
2266                                                          message_file,
2267                                                          &thread_id);
2268         if (ret)
2269             goto DONE;
2270
2271         if (thread_id == NULL)
2272             thread_id = orig_thread_id;
2273
2274         _notmuch_message_add_term (message, "thread", thread_id);
2275         /* Take header values only from first filename */
2276         if (found == 0)
2277             _notmuch_message_set_header_values (message, date, from, subject);
2278
2279         ret = _notmuch_message_index_file (message, indexopts, message_file);
2280
2281         if (ret == NOTMUCH_STATUS_FILE_ERROR)
2282             continue;
2283         if (ret)
2284             goto DONE;
2285
2286         found++;
2287         _notmuch_message_file_close (message_file);
2288         message_file = NULL;
2289     }
2290     if (found == 0) {
2291         /* put back thread id to help cleanup */
2292         _notmuch_message_add_term (message, "thread", orig_thread_id);
2293         ret = _notmuch_message_delete (message);
2294     } else {
2295         _notmuch_message_sync (message);
2296     }
2297
2298   DONE:
2299     if (message_file)
2300         _notmuch_message_file_close (message_file);
2301
2302     /* XXX TODO destroy orig_filenames? */
2303     return ret;
2304 }