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