]> git.notmuchmail.org Git - notmuch/blob - lib/message.cc
lib: Internal support for querying and creating ghost messages
[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 http://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
24 #include <stdint.h>
25
26 #include <gmime/gmime.h>
27
28 struct visible _notmuch_message {
29     notmuch_database_t *notmuch;
30     Xapian::docid doc_id;
31     int frozen;
32     char *message_id;
33     char *thread_id;
34     char *in_reply_to;
35     notmuch_string_list_t *tag_list;
36     notmuch_string_list_t *filename_term_list;
37     notmuch_string_list_t *filename_list;
38     char *author;
39     notmuch_message_file_t *message_file;
40     notmuch_message_list_t *replies;
41     unsigned long flags;
42     /* For flags that are initialized on-demand, lazy_flags indicates
43      * if each flag has been initialized. */
44     unsigned long lazy_flags;
45
46     Xapian::Document doc;
47     Xapian::termcount termpos;
48 };
49
50 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
51
52 struct maildir_flag_tag {
53     char flag;
54     const char *tag;
55     notmuch_bool_t inverse;
56 };
57
58 /* ASCII ordered table of Maildir flags and associated tags */
59 static struct maildir_flag_tag flag2tag[] = {
60     { 'D', "draft",   FALSE},
61     { 'F', "flagged", FALSE},
62     { 'P', "passed",  FALSE},
63     { 'R', "replied", FALSE},
64     { 'S', "unread",  TRUE }
65 };
66
67 /* We end up having to call the destructor explicitly because we had
68  * to use "placement new" in order to initialize C++ objects within a
69  * block that we allocated with talloc. So C++ is making talloc
70  * slightly less simple to use, (we wouldn't need
71  * talloc_set_destructor at all otherwise).
72  */
73 static int
74 _notmuch_message_destructor (notmuch_message_t *message)
75 {
76     message->doc.~Document ();
77
78     return 0;
79 }
80
81 static notmuch_message_t *
82 _notmuch_message_create_for_document (const void *talloc_owner,
83                                       notmuch_database_t *notmuch,
84                                       unsigned int doc_id,
85                                       Xapian::Document doc,
86                                       notmuch_private_status_t *status)
87 {
88     notmuch_message_t *message;
89
90     if (status)
91         *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
92
93     message = talloc (talloc_owner, notmuch_message_t);
94     if (unlikely (message == NULL)) {
95         if (status)
96             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
97         return NULL;
98     }
99
100     message->notmuch = notmuch;
101     message->doc_id = doc_id;
102
103     message->frozen = 0;
104     message->flags = 0;
105     message->lazy_flags = 0;
106
107     /* Each of these will be lazily created as needed. */
108     message->message_id = NULL;
109     message->thread_id = NULL;
110     message->in_reply_to = NULL;
111     message->tag_list = NULL;
112     message->filename_term_list = NULL;
113     message->filename_list = NULL;
114     message->message_file = NULL;
115     message->author = NULL;
116
117     message->replies = _notmuch_message_list_create (message);
118     if (unlikely (message->replies == NULL)) {
119         if (status)
120             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
121         return NULL;
122     }
123
124     /* This is C++'s creepy "placement new", which is really just an
125      * ugly way to call a constructor for a pre-allocated object. So
126      * it's really not an error to not be checking for OUT_OF_MEMORY
127      * here, since this "new" isn't actually allocating memory. This
128      * is language-design comedy of the wrong kind. */
129
130     new (&message->doc) Xapian::Document;
131
132     talloc_set_destructor (message, _notmuch_message_destructor);
133
134     message->doc = doc;
135     message->termpos = 0;
136
137     return message;
138 }
139
140 /* Create a new notmuch_message_t object for an existing document in
141  * the database.
142  *
143  * Here, 'talloc owner' is an optional talloc context to which the new
144  * message will belong. This allows for the caller to not bother
145  * calling notmuch_message_destroy on the message, and know that all
146  * memory will be reclaimed when 'talloc_owner' is freed. The caller
147  * still can call notmuch_message_destroy when finished with the
148  * message if desired.
149  *
150  * The 'talloc_owner' argument can also be NULL, in which case the
151  * caller *is* responsible for calling notmuch_message_destroy.
152  *
153  * If no document exists in the database with document ID of 'doc_id'
154  * then this function returns NULL and optionally sets *status to
155  * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
156  *
157  * This function can also fail to due lack of available memory,
158  * returning NULL and optionally setting *status to
159  * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
160  *
161  * The caller can pass NULL for status if uninterested in
162  * distinguishing these two cases.
163  */
164 notmuch_message_t *
165 _notmuch_message_create (const void *talloc_owner,
166                          notmuch_database_t *notmuch,
167                          unsigned int doc_id,
168                          notmuch_private_status_t *status)
169 {
170     Xapian::Document doc;
171
172     try {
173         doc = notmuch->xapian_db->get_document (doc_id);
174     } catch (const Xapian::DocNotFoundError &error) {
175         if (status)
176             *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
177         return NULL;
178     }
179
180     return _notmuch_message_create_for_document (talloc_owner, notmuch,
181                                                  doc_id, doc, status);
182 }
183
184 /* Create a new notmuch_message_t object for a specific message ID,
185  * (which may or may not already exist in the database).
186  *
187  * The 'notmuch' database will be the talloc owner of the returned
188  * message.
189  *
190  * This function returns a valid notmuch_message_t whether or not
191  * there is already a document in the database with the given message
192  * ID. These two cases can be distinguished by the value of *status:
193  *
194  *
195  *   NOTMUCH_PRIVATE_STATUS_SUCCESS:
196  *
197  *     There is already a document with message ID 'message_id' in the
198  *     database. The returned message can be used to query/modify the
199  *     document. The message may be a ghost message.
200  *
201  *   NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:
202  *
203  *     No document with 'message_id' exists in the database. The
204  *     returned message contains a newly created document (not yet
205  *     added to the database) and a document ID that is known not to
206  *     exist in the database.  This message is "blank"; that is, it
207  *     contains only a message ID and no other metadata. The caller
208  *     can modify the message, and a call to _notmuch_message_sync
209  *     will add the document to the database.
210  *
211  * If an error occurs, this function will return NULL and *status
212  * will be set as appropriate. (The status pointer argument must
213  * not be NULL.)
214  */
215 notmuch_message_t *
216 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
217                                         const char *message_id,
218                                         notmuch_private_status_t *status_ret)
219 {
220     notmuch_message_t *message;
221     Xapian::Document doc;
222     unsigned int doc_id;
223     char *term;
224
225     *status_ret = (notmuch_private_status_t) notmuch_database_find_message (notmuch,
226                                                                             message_id,
227                                                                             &message);
228     if (message)
229         return talloc_steal (notmuch, message);
230     else if (*status_ret)
231         return NULL;
232
233     /* If the message ID is too long, substitute its sha1 instead. */
234     if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
235         message_id = _notmuch_message_id_compressed (message, message_id);
236
237     term = talloc_asprintf (NULL, "%s%s",
238                             _find_prefix ("id"), message_id);
239     if (term == NULL) {
240         *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
241         return NULL;
242     }
243
244     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
245         INTERNAL_ERROR ("Failure to ensure database is writable.");
246
247     try {
248         doc.add_term (term, 0);
249         talloc_free (term);
250
251         doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
252
253         doc_id = _notmuch_database_generate_doc_id (notmuch);
254     } catch (const Xapian::Error &error) {
255         fprintf (stderr, "A Xapian exception occurred creating message: %s\n",
256                  error.get_msg().c_str());
257         notmuch->exception_reported = TRUE;
258         *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
259         return NULL;
260     }
261
262     message = _notmuch_message_create_for_document (notmuch, notmuch,
263                                                     doc_id, doc, status_ret);
264
265     /* We want to inform the caller that we had to create a new
266      * document. */
267     if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
268         *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
269
270     return message;
271 }
272
273 static char *
274 _notmuch_message_get_term (notmuch_message_t *message,
275                            Xapian::TermIterator &i, Xapian::TermIterator &end,
276                            const char *prefix)
277 {
278     int prefix_len = strlen (prefix);
279     char *value;
280
281     i.skip_to (prefix);
282
283     if (i == end)
284         return NULL;
285
286     std::string term = *i;
287     if (strncmp (term.c_str(), prefix, prefix_len))
288         return NULL;
289
290     value = talloc_strdup (message, term.c_str() + prefix_len);
291
292 #if DEBUG_DATABASE_SANITY
293     i++;
294
295     if (i != end && strncmp ((*i).c_str (), prefix, prefix_len) == 0) {
296         INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate %s terms: %s and %s\n",
297                         message->doc_id, prefix, value,
298                         (*i).c_str () + prefix_len);
299     }
300 #endif
301
302     return value;
303 }
304
305 void
306 _notmuch_message_ensure_metadata (notmuch_message_t *message)
307 {
308     Xapian::TermIterator i, end;
309     const char *thread_prefix = _find_prefix ("thread"),
310         *tag_prefix = _find_prefix ("tag"),
311         *id_prefix = _find_prefix ("id"),
312         *type_prefix = _find_prefix ("type"),
313         *filename_prefix = _find_prefix ("file-direntry"),
314         *replyto_prefix = _find_prefix ("replyto");
315
316     /* We do this all in a single pass because Xapian decompresses the
317      * term list every time you iterate over it.  Thus, while this is
318      * slightly more costly than looking up individual fields if only
319      * one field of the message object is actually used, it's a huge
320      * win as more fields are used. */
321
322     i = message->doc.termlist_begin ();
323     end = message->doc.termlist_end ();
324
325     /* Get thread */
326     if (!message->thread_id)
327         message->thread_id =
328             _notmuch_message_get_term (message, i, end, thread_prefix);
329
330     /* Get tags */
331     assert (strcmp (thread_prefix, tag_prefix) < 0);
332     if (!message->tag_list) {
333         message->tag_list =
334             _notmuch_database_get_terms_with_prefix (message, i, end,
335                                                      tag_prefix);
336         _notmuch_string_list_sort (message->tag_list);
337     }
338
339     /* Get id */
340     assert (strcmp (tag_prefix, id_prefix) < 0);
341     if (!message->message_id)
342         message->message_id =
343             _notmuch_message_get_term (message, i, end, id_prefix);
344
345     /* Get document type */
346     assert (strcmp (id_prefix, type_prefix) < 0);
347     if (! NOTMUCH_TEST_BIT (message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST)) {
348         i.skip_to (type_prefix);
349         /* "T" is the prefix "type" fields.  See
350          * BOOLEAN_PREFIX_INTERNAL. */
351         if (*i == "Tmail")
352             NOTMUCH_CLEAR_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
353         else if (*i == "Tghost")
354             NOTMUCH_SET_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
355         else
356             INTERNAL_ERROR ("Message without type term");
357         NOTMUCH_SET_BIT (&message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST);
358     }
359
360     /* Get filename list.  Here we get only the terms.  We lazily
361      * expand them to full file names when needed in
362      * _notmuch_message_ensure_filename_list. */
363     assert (strcmp (type_prefix, filename_prefix) < 0);
364     if (!message->filename_term_list && !message->filename_list)
365         message->filename_term_list =
366             _notmuch_database_get_terms_with_prefix (message, i, end,
367                                                      filename_prefix);
368
369     /* Get reply to */
370     assert (strcmp (filename_prefix, replyto_prefix) < 0);
371     if (!message->in_reply_to)
372         message->in_reply_to =
373             _notmuch_message_get_term (message, i, end, replyto_prefix);
374     /* It's perfectly valid for a message to have no In-Reply-To
375      * header. For these cases, we return an empty string. */
376     if (!message->in_reply_to)
377         message->in_reply_to = talloc_strdup (message, "");
378 }
379
380 static void
381 _notmuch_message_invalidate_metadata (notmuch_message_t *message,
382                                       const char *prefix_name)
383 {
384     if (strcmp ("thread", prefix_name) == 0) {
385         talloc_free (message->thread_id);
386         message->thread_id = NULL;
387     }
388
389     if (strcmp ("tag", prefix_name) == 0) {
390         talloc_unlink (message, message->tag_list);
391         message->tag_list = NULL;
392     }
393
394     if (strcmp ("type", prefix_name) == 0) {
395         NOTMUCH_CLEAR_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
396         NOTMUCH_CLEAR_BIT (&message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST);
397     }
398
399     if (strcmp ("file-direntry", prefix_name) == 0) {
400         talloc_free (message->filename_term_list);
401         talloc_free (message->filename_list);
402         message->filename_term_list = message->filename_list = NULL;
403     }
404
405     if (strcmp ("replyto", prefix_name) == 0) {
406         talloc_free (message->in_reply_to);
407         message->in_reply_to = NULL;
408     }
409 }
410
411 unsigned int
412 _notmuch_message_get_doc_id (notmuch_message_t *message)
413 {
414     return message->doc_id;
415 }
416
417 const char *
418 notmuch_message_get_message_id (notmuch_message_t *message)
419 {
420     if (!message->message_id)
421         _notmuch_message_ensure_metadata (message);
422     if (!message->message_id)
423         INTERNAL_ERROR ("Message with document ID of %u has no message ID.\n",
424                         message->doc_id);
425     return message->message_id;
426 }
427
428 static void
429 _notmuch_message_ensure_message_file (notmuch_message_t *message)
430 {
431     const char *filename;
432
433     if (message->message_file)
434         return;
435
436     filename = notmuch_message_get_filename (message);
437     if (unlikely (filename == NULL))
438         return;
439
440     message->message_file = _notmuch_message_file_open_ctx (message, filename);
441 }
442
443 const char *
444 notmuch_message_get_header (notmuch_message_t *message, const char *header)
445 {
446     Xapian::valueno slot = Xapian::BAD_VALUENO;
447
448     /* Fetch header from the appropriate xapian value field if
449      * available */
450     if (strcasecmp (header, "from") == 0)
451         slot = NOTMUCH_VALUE_FROM;
452     else if (strcasecmp (header, "subject") == 0)
453         slot = NOTMUCH_VALUE_SUBJECT;
454     else if (strcasecmp (header, "message-id") == 0)
455         slot = NOTMUCH_VALUE_MESSAGE_ID;
456
457     if (slot != Xapian::BAD_VALUENO) {
458         try {
459             std::string value = message->doc.get_value (slot);
460
461             /* If we have NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES, then
462              * empty values indicate empty headers.  If we don't, then
463              * it could just mean we didn't record the header. */
464             if ((message->notmuch->features &
465                  NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES) ||
466                 ! value.empty())
467                 return talloc_strdup (message, value.c_str ());
468
469         } catch (Xapian::Error &error) {
470             fprintf (stderr, "A Xapian exception occurred when reading header: %s\n",
471                      error.get_msg().c_str());
472             message->notmuch->exception_reported = TRUE;
473             return NULL;
474         }
475     }
476
477     /* Otherwise fall back to parsing the file */
478     _notmuch_message_ensure_message_file (message);
479     if (message->message_file == NULL)
480         return NULL;
481
482     return _notmuch_message_file_get_header (message->message_file, header);
483 }
484
485 /* Return the message ID from the In-Reply-To header of 'message'.
486  *
487  * Returns an empty string ("") if 'message' has no In-Reply-To
488  * header.
489  *
490  * Returns NULL if any error occurs.
491  */
492 const char *
493 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
494 {
495     if (!message->in_reply_to)
496         _notmuch_message_ensure_metadata (message);
497     return message->in_reply_to;
498 }
499
500 const char *
501 notmuch_message_get_thread_id (notmuch_message_t *message)
502 {
503     if (!message->thread_id)
504         _notmuch_message_ensure_metadata (message);
505     if (!message->thread_id)
506         INTERNAL_ERROR ("Message with document ID of %u has no thread ID.\n",
507                         message->doc_id);
508     return message->thread_id;
509 }
510
511 void
512 _notmuch_message_add_reply (notmuch_message_t *message,
513                             notmuch_message_t *reply)
514 {
515     _notmuch_message_list_add_message (message->replies, reply);
516 }
517
518 notmuch_messages_t *
519 notmuch_message_get_replies (notmuch_message_t *message)
520 {
521     return _notmuch_messages_create (message->replies);
522 }
523
524 static void
525 _notmuch_message_remove_terms (notmuch_message_t *message, const char *prefix)
526 {
527     Xapian::TermIterator i;
528     size_t prefix_len = strlen (prefix);
529
530     while (1) {
531         i = message->doc.termlist_begin ();
532         i.skip_to (prefix);
533
534         /* Terminate loop when no terms remain with desired prefix. */
535         if (i == message->doc.termlist_end () ||
536             strncmp ((*i).c_str (), prefix, prefix_len))
537             break;
538
539         try {
540             message->doc.remove_term ((*i));
541         } catch (const Xapian::InvalidArgumentError) {
542             /* Ignore failure to remove non-existent term. */
543         }
544     }
545 }
546
547 /* Return true if p points at "new" or "cur". */
548 static bool is_maildir (const char *p)
549 {
550     return strcmp (p, "cur") == 0 || strcmp (p, "new") == 0;
551 }
552
553 /* Add "folder:" term for directory. */
554 static notmuch_status_t
555 _notmuch_message_add_folder_terms (notmuch_message_t *message,
556                                    const char *directory)
557 {
558     char *folder, *last;
559
560     folder = talloc_strdup (NULL, directory);
561     if (! folder)
562         return NOTMUCH_STATUS_OUT_OF_MEMORY;
563
564     /*
565      * If the message file is in a leaf directory named "new" or
566      * "cur", presume maildir and index the parent directory. Thus a
567      * "folder:" prefix search matches messages in the specified
568      * maildir folder, i.e. in the specified directory and its "new"
569      * and "cur" subdirectories.
570      *
571      * Note that this means the "folder:" prefix can't be used for
572      * distinguishing between message files in "new" or "cur". The
573      * "path:" prefix needs to be used for that.
574      *
575      * Note the deliberate difference to _filename_is_in_maildir(). We
576      * don't want to index different things depending on the existence
577      * or non-existence of all maildir sibling directories "new",
578      * "cur", and "tmp". Doing so would be surprising, and difficult
579      * for the user to fix in case all subdirectories were not in
580      * place during indexing.
581      */
582     last = strrchr (folder, '/');
583     if (last) {
584         if (is_maildir (last + 1))
585             *last = '\0';
586     } else if (is_maildir (folder)) {
587         *folder = '\0';
588     }
589
590     _notmuch_message_add_term (message, "folder", folder);
591
592     talloc_free (folder);
593
594     return NOTMUCH_STATUS_SUCCESS;
595 }
596
597 #define RECURSIVE_SUFFIX "/**"
598
599 /* Add "path:" terms for directory. */
600 static notmuch_status_t
601 _notmuch_message_add_path_terms (notmuch_message_t *message,
602                                  const char *directory)
603 {
604     /* Add exact "path:" term. */
605     _notmuch_message_add_term (message, "path", directory);
606
607     if (strlen (directory)) {
608         char *path, *p;
609
610         path = talloc_asprintf (NULL, "%s%s", directory, RECURSIVE_SUFFIX);
611         if (! path)
612             return NOTMUCH_STATUS_OUT_OF_MEMORY;
613
614         /* Add recursive "path:" terms for directory and all parents. */
615         for (p = path + strlen (path) - 1; p > path; p--) {
616             if (*p == '/') {
617                 strcpy (p, RECURSIVE_SUFFIX);
618                 _notmuch_message_add_term (message, "path", path);
619             }
620         }
621
622         talloc_free (path);
623     }
624
625     /* Recursive all-matching path:** for consistency. */
626     _notmuch_message_add_term (message, "path", "**");
627
628     return NOTMUCH_STATUS_SUCCESS;
629 }
630
631 /* Add directory based terms for all filenames of the message. */
632 static notmuch_status_t
633 _notmuch_message_add_directory_terms (void *ctx, notmuch_message_t *message)
634 {
635     const char *direntry_prefix = _find_prefix ("file-direntry");
636     int direntry_prefix_len = strlen (direntry_prefix);
637     Xapian::TermIterator i = message->doc.termlist_begin ();
638     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
639
640     for (i.skip_to (direntry_prefix); i != message->doc.termlist_end (); i++) {
641         unsigned int directory_id;
642         const char *direntry, *directory;
643         char *colon;
644
645         /* Terminate loop at first term without desired prefix. */
646         if (strncmp ((*i).c_str (), direntry_prefix, direntry_prefix_len))
647             break;
648
649         /* Indicate that there are filenames remaining. */
650         status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
651
652         direntry = (*i).c_str ();
653         direntry += direntry_prefix_len;
654
655         directory_id = strtol (direntry, &colon, 10);
656
657         if (colon == NULL || *colon != ':')
658             INTERNAL_ERROR ("malformed direntry");
659
660         directory = _notmuch_database_get_directory_path (ctx,
661                                                           message->notmuch,
662                                                           directory_id);
663
664         _notmuch_message_add_folder_terms (message, directory);
665         _notmuch_message_add_path_terms (message, directory);
666     }
667
668     return status;
669 }
670
671 /* Add an additional 'filename' for 'message'.
672  *
673  * This change will not be reflected in the database until the next
674  * call to _notmuch_message_sync. */
675 notmuch_status_t
676 _notmuch_message_add_filename (notmuch_message_t *message,
677                                const char *filename)
678 {
679     const char *relative, *directory;
680     notmuch_status_t status;
681     void *local = talloc_new (message);
682     char *direntry;
683
684     if (filename == NULL)
685         INTERNAL_ERROR ("Message filename cannot be NULL.");
686
687     if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
688         ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
689         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
690
691     relative = _notmuch_database_relative_path (message->notmuch, filename);
692
693     status = _notmuch_database_split_path (local, relative, &directory, NULL);
694     if (status)
695         return status;
696
697     status = _notmuch_database_filename_to_direntry (
698         local, message->notmuch, filename, NOTMUCH_FIND_CREATE, &direntry);
699     if (status)
700         return status;
701
702     /* New file-direntry allows navigating to this message with
703      * notmuch_directory_get_child_files() . */
704     _notmuch_message_add_term (message, "file-direntry", direntry);
705
706     _notmuch_message_add_folder_terms (message, directory);
707     _notmuch_message_add_path_terms (message, directory);
708
709     talloc_free (local);
710
711     return NOTMUCH_STATUS_SUCCESS;
712 }
713
714 /* Remove a particular 'filename' from 'message'.
715  *
716  * This change will not be reflected in the database until the next
717  * call to _notmuch_message_sync.
718  *
719  * If this message still has other filenames, returns
720  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
721  *
722  * Note: This function does not remove a document from the database,
723  * even if the specified filename is the only filename for this
724  * message. For that functionality, see
725  * _notmuch_database_remove_message. */
726 notmuch_status_t
727 _notmuch_message_remove_filename (notmuch_message_t *message,
728                                   const char *filename)
729 {
730     void *local = talloc_new (message);
731     char *direntry;
732     notmuch_private_status_t private_status;
733     notmuch_status_t status;
734
735     if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
736         ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
737         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
738
739     status = _notmuch_database_filename_to_direntry (
740         local, message->notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
741     if (status || !direntry)
742         return status;
743
744     /* Unlink this file from its parent directory. */
745     private_status = _notmuch_message_remove_term (message,
746                                                    "file-direntry", direntry);
747     status = COERCE_STATUS (private_status,
748                             "Unexpected error from _notmuch_message_remove_term");
749     if (status)
750         return status;
751
752     /* Re-synchronize "folder:" and "path:" terms for this message. */
753
754     /* Remove all "folder:" terms. */
755     _notmuch_message_remove_terms (message, _find_prefix ("folder"));
756
757     /* Remove all "path:" terms. */
758     _notmuch_message_remove_terms (message, _find_prefix ("path"));
759
760     /* Add back terms for all remaining filenames of the message. */
761     status = _notmuch_message_add_directory_terms (local, message);
762
763     talloc_free (local);
764
765     return status;
766 }
767
768 /* Upgrade the "folder:" prefix from V1 to V2. */
769 #define FOLDER_PREFIX_V1       "XFOLDER"
770 #define ZFOLDER_PREFIX_V1      "Z" FOLDER_PREFIX_V1
771 void
772 _notmuch_message_upgrade_folder (notmuch_message_t *message)
773 {
774     /* Remove all old "folder:" terms. */
775     _notmuch_message_remove_terms (message, FOLDER_PREFIX_V1);
776
777     /* Remove all old "folder:" stemmed terms. */
778     _notmuch_message_remove_terms (message, ZFOLDER_PREFIX_V1);
779
780     /* Add new boolean "folder:" and "path:" terms. */
781     _notmuch_message_add_directory_terms (message, message);
782 }
783
784 char *
785 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
786 {
787     return talloc_strdup (message, message->doc.get_data ().c_str ());
788 }
789
790 void
791 _notmuch_message_clear_data (notmuch_message_t *message)
792 {
793     message->doc.set_data ("");
794 }
795
796 static void
797 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
798 {
799     notmuch_string_node_t *node;
800
801     if (message->filename_list)
802         return;
803
804     if (!message->filename_term_list)
805         _notmuch_message_ensure_metadata (message);
806
807     message->filename_list = _notmuch_string_list_create (message);
808     node = message->filename_term_list->head;
809
810     if (!node) {
811         /* A message document created by an old version of notmuch
812          * (prior to rename support) will have the filename in the
813          * data of the document rather than as a file-direntry term.
814          *
815          * It would be nice to do the upgrade of the document directly
816          * here, but the database is likely open in read-only mode. */
817         const char *data;
818
819         data = message->doc.get_data ().c_str ();
820
821         if (data == NULL)
822             INTERNAL_ERROR ("message with no filename");
823
824         _notmuch_string_list_append (message->filename_list, data);
825
826         return;
827     }
828
829     for (; node; node = node->next) {
830         void *local = talloc_new (message);
831         const char *db_path, *directory, *basename, *filename;
832         char *colon, *direntry = NULL;
833         unsigned int directory_id;
834
835         direntry = node->string;
836
837         directory_id = strtol (direntry, &colon, 10);
838
839         if (colon == NULL || *colon != ':')
840             INTERNAL_ERROR ("malformed direntry");
841
842         basename = colon + 1;
843
844         *colon = '\0';
845
846         db_path = notmuch_database_get_path (message->notmuch);
847
848         directory = _notmuch_database_get_directory_path (local,
849                                                           message->notmuch,
850                                                           directory_id);
851
852         if (strlen (directory))
853             filename = talloc_asprintf (message, "%s/%s/%s",
854                                         db_path, directory, basename);
855         else
856             filename = talloc_asprintf (message, "%s/%s",
857                                         db_path, basename);
858
859         _notmuch_string_list_append (message->filename_list, filename);
860
861         talloc_free (local);
862     }
863
864     talloc_free (message->filename_term_list);
865     message->filename_term_list = NULL;
866 }
867
868 const char *
869 notmuch_message_get_filename (notmuch_message_t *message)
870 {
871     _notmuch_message_ensure_filename_list (message);
872
873     if (message->filename_list == NULL)
874         return NULL;
875
876     if (message->filename_list->head == NULL ||
877         message->filename_list->head->string == NULL)
878     {
879         INTERNAL_ERROR ("message with no filename");
880     }
881
882     return message->filename_list->head->string;
883 }
884
885 notmuch_filenames_t *
886 notmuch_message_get_filenames (notmuch_message_t *message)
887 {
888     _notmuch_message_ensure_filename_list (message);
889
890     return _notmuch_filenames_create (message, message->filename_list);
891 }
892
893 notmuch_bool_t
894 notmuch_message_get_flag (notmuch_message_t *message,
895                           notmuch_message_flag_t flag)
896 {
897     if (flag == NOTMUCH_MESSAGE_FLAG_GHOST &&
898         ! NOTMUCH_TEST_BIT (message->lazy_flags, flag))
899         _notmuch_message_ensure_metadata (message);
900
901     return NOTMUCH_TEST_BIT (message->flags, flag);
902 }
903
904 void
905 notmuch_message_set_flag (notmuch_message_t *message,
906                           notmuch_message_flag_t flag, notmuch_bool_t enable)
907 {
908     if (enable)
909         NOTMUCH_SET_BIT (&message->flags, flag);
910     else
911         NOTMUCH_CLEAR_BIT (&message->flags, flag);
912     NOTMUCH_SET_BIT (&message->lazy_flags, flag);
913 }
914
915 time_t
916 notmuch_message_get_date (notmuch_message_t *message)
917 {
918     std::string value;
919
920     try {
921         value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
922     } catch (Xapian::Error &error) {
923         fprintf (stderr, "A Xapian exception occurred when reading date: %s\n",
924                  error.get_msg().c_str());
925         message->notmuch->exception_reported = TRUE;
926         return 0;
927     }
928
929     if (value.empty ())
930         /* sortable_unserialise is undefined on empty string */
931         return 0;
932     return Xapian::sortable_unserialise (value);
933 }
934
935 notmuch_tags_t *
936 notmuch_message_get_tags (notmuch_message_t *message)
937 {
938     notmuch_tags_t *tags;
939
940     if (!message->tag_list)
941         _notmuch_message_ensure_metadata (message);
942
943     tags = _notmuch_tags_create (message, message->tag_list);
944     /* _notmuch_tags_create steals the reference to the tag_list, but
945      * in this case it's still used by the message, so we add an
946      * *additional* talloc reference to the list.  As a result, it's
947      * possible to modify the message tags (which talloc_unlink's the
948      * current list from the message) while still iterating because
949      * the iterator will keep the current list alive. */
950     if (!talloc_reference (message, message->tag_list))
951         return NULL;
952
953     return tags;
954 }
955
956 const char *
957 _notmuch_message_get_author (notmuch_message_t *message)
958 {
959     return message->author;
960 }
961
962 void
963 _notmuch_message_set_author (notmuch_message_t *message,
964                             const char *author)
965 {
966     if (message->author)
967         talloc_free(message->author);
968     message->author = talloc_strdup(message, author);
969     return;
970 }
971
972 void
973 _notmuch_message_set_header_values (notmuch_message_t *message,
974                                     const char *date,
975                                     const char *from,
976                                     const char *subject)
977 {
978     time_t time_value;
979
980     /* GMime really doesn't want to see a NULL date, so protect its
981      * sensibilities. */
982     if (date == NULL || *date == '\0')
983         time_value = 0;
984     else
985         time_value = g_mime_utils_header_decode_date (date, NULL);
986
987     message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
988                             Xapian::sortable_serialise (time_value));
989     message->doc.add_value (NOTMUCH_VALUE_FROM, from);
990     message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
991 }
992
993 /* Synchronize changes made to message->doc out into the database. */
994 void
995 _notmuch_message_sync (notmuch_message_t *message)
996 {
997     Xapian::WritableDatabase *db;
998
999     if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
1000         return;
1001
1002     db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
1003     db->replace_document (message->doc_id, message->doc);
1004 }
1005
1006 /* Delete a message document from the database. */
1007 notmuch_status_t
1008 _notmuch_message_delete (notmuch_message_t *message)
1009 {
1010     notmuch_status_t status;
1011     Xapian::WritableDatabase *db;
1012
1013     status = _notmuch_database_ensure_writable (message->notmuch);
1014     if (status)
1015         return status;
1016
1017     db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
1018     db->delete_document (message->doc_id);
1019     return NOTMUCH_STATUS_SUCCESS;
1020 }
1021
1022 /* Transform a blank message into a ghost message.  The caller must
1023  * _notmuch_message_sync the message. */
1024 notmuch_private_status_t
1025 _notmuch_message_initialize_ghost (notmuch_message_t *message,
1026                                    const char *thread_id)
1027 {
1028     notmuch_private_status_t status;
1029
1030     status = _notmuch_message_add_term (message, "type", "ghost");
1031     if (status)
1032         return status;
1033     status = _notmuch_message_add_term (message, "thread", thread_id);
1034     if (status)
1035         return status;
1036
1037     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1038 }
1039
1040 /* Ensure that 'message' is not holding any file object open. Future
1041  * calls to various functions will still automatically open the
1042  * message file as needed.
1043  */
1044 void
1045 _notmuch_message_close (notmuch_message_t *message)
1046 {
1047     if (message->message_file) {
1048         _notmuch_message_file_close (message->message_file);
1049         message->message_file = NULL;
1050     }
1051 }
1052
1053 /* Add a name:value term to 'message', (the actual term will be
1054  * encoded by prefixing the value with a short prefix). See
1055  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1056  * names to prefix values.
1057  *
1058  * This change will not be reflected in the database until the next
1059  * call to _notmuch_message_sync. */
1060 notmuch_private_status_t
1061 _notmuch_message_add_term (notmuch_message_t *message,
1062                            const char *prefix_name,
1063                            const char *value)
1064 {
1065
1066     char *term;
1067
1068     if (value == NULL)
1069         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1070
1071     term = talloc_asprintf (message, "%s%s",
1072                             _find_prefix (prefix_name), value);
1073
1074     if (strlen (term) > NOTMUCH_TERM_MAX)
1075         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1076
1077     message->doc.add_term (term, 0);
1078
1079     talloc_free (term);
1080
1081     _notmuch_message_invalidate_metadata (message, prefix_name);
1082
1083     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1084 }
1085
1086 /* Parse 'text' and add a term to 'message' for each parsed word. Each
1087  * term will be added both prefixed (if prefix_name is not NULL) and
1088  * also non-prefixed). */
1089 notmuch_private_status_t
1090 _notmuch_message_gen_terms (notmuch_message_t *message,
1091                             const char *prefix_name,
1092                             const char *text)
1093 {
1094     Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
1095
1096     if (text == NULL)
1097         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1098
1099     term_gen->set_document (message->doc);
1100
1101     if (prefix_name) {
1102         const char *prefix = _find_prefix (prefix_name);
1103
1104         term_gen->set_termpos (message->termpos);
1105         term_gen->index_text (text, 1, prefix);
1106         /* Create a gap between this an the next terms so they don't
1107          * appear to be a phrase. */
1108         message->termpos = term_gen->get_termpos () + 100;
1109
1110         _notmuch_message_invalidate_metadata (message, prefix_name);
1111     }
1112
1113     term_gen->set_termpos (message->termpos);
1114     term_gen->index_text (text);
1115     /* Create a term gap, as above. */
1116     message->termpos = term_gen->get_termpos () + 100;
1117
1118     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1119 }
1120
1121 /* Remove a name:value term from 'message', (the actual term will be
1122  * encoded by prefixing the value with a short prefix). See
1123  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1124  * names to prefix values.
1125  *
1126  * This change will not be reflected in the database until the next
1127  * call to _notmuch_message_sync. */
1128 notmuch_private_status_t
1129 _notmuch_message_remove_term (notmuch_message_t *message,
1130                               const char *prefix_name,
1131                               const char *value)
1132 {
1133     char *term;
1134
1135     if (value == NULL)
1136         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1137
1138     term = talloc_asprintf (message, "%s%s",
1139                             _find_prefix (prefix_name), value);
1140
1141     if (strlen (term) > NOTMUCH_TERM_MAX)
1142         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1143
1144     try {
1145         message->doc.remove_term (term);
1146     } catch (const Xapian::InvalidArgumentError) {
1147         /* We'll let the philosopher's try to wrestle with the
1148          * question of whether failing to remove that which was not
1149          * there in the first place is failure. For us, we'll silently
1150          * consider it all good. */
1151     }
1152
1153     talloc_free (term);
1154
1155     _notmuch_message_invalidate_metadata (message, prefix_name);
1156
1157     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1158 }
1159
1160 notmuch_status_t
1161 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
1162 {
1163     notmuch_private_status_t private_status;
1164     notmuch_status_t status;
1165
1166     status = _notmuch_database_ensure_writable (message->notmuch);
1167     if (status)
1168         return status;
1169
1170     if (tag == NULL)
1171         return NOTMUCH_STATUS_NULL_POINTER;
1172
1173     if (strlen (tag) > NOTMUCH_TAG_MAX)
1174         return NOTMUCH_STATUS_TAG_TOO_LONG;
1175
1176     private_status = _notmuch_message_add_term (message, "tag", tag);
1177     if (private_status) {
1178         INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
1179                         private_status);
1180     }
1181
1182     if (! message->frozen)
1183         _notmuch_message_sync (message);
1184
1185     return NOTMUCH_STATUS_SUCCESS;
1186 }
1187
1188 notmuch_status_t
1189 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
1190 {
1191     notmuch_private_status_t private_status;
1192     notmuch_status_t status;
1193
1194     status = _notmuch_database_ensure_writable (message->notmuch);
1195     if (status)
1196         return status;
1197
1198     if (tag == NULL)
1199         return NOTMUCH_STATUS_NULL_POINTER;
1200
1201     if (strlen (tag) > NOTMUCH_TAG_MAX)
1202         return NOTMUCH_STATUS_TAG_TOO_LONG;
1203
1204     private_status = _notmuch_message_remove_term (message, "tag", tag);
1205     if (private_status) {
1206         INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1207                         private_status);
1208     }
1209
1210     if (! message->frozen)
1211         _notmuch_message_sync (message);
1212
1213     return NOTMUCH_STATUS_SUCCESS;
1214 }
1215
1216 /* Is the given filename within a maildir directory?
1217  *
1218  * Specifically, is the final directory component of 'filename' either
1219  * "cur" or "new". If so, return a pointer to that final directory
1220  * component within 'filename'. If not, return NULL.
1221  *
1222  * A non-NULL return value is guaranteed to be a valid string pointer
1223  * pointing to the characters "new/" or "cur/", (but not
1224  * NUL-terminated).
1225  */
1226 static const char *
1227 _filename_is_in_maildir (const char *filename)
1228 {
1229     const char *slash, *dir = NULL;
1230
1231     /* Find the last '/' separating directory from filename. */
1232     slash = strrchr (filename, '/');
1233     if (slash == NULL)
1234         return NULL;
1235
1236     /* Jump back 4 characters to where the previous '/' will be if the
1237      * directory is named "cur" or "new". */
1238     if (slash - filename < 4)
1239         return NULL;
1240
1241     slash -= 4;
1242
1243     if (*slash != '/')
1244         return NULL;
1245
1246     dir = slash + 1;
1247
1248     if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1249         STRNCMP_LITERAL (dir, "new/") == 0)
1250     {
1251         return dir;
1252     }
1253
1254     return NULL;
1255 }
1256
1257 notmuch_status_t
1258 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1259 {
1260     const char *flags;
1261     notmuch_status_t status;
1262     notmuch_filenames_t *filenames;
1263     const char *filename, *dir;
1264     char *combined_flags = talloc_strdup (message, "");
1265     unsigned i;
1266     int seen_maildir_info = 0;
1267
1268     for (filenames = notmuch_message_get_filenames (message);
1269          notmuch_filenames_valid (filenames);
1270          notmuch_filenames_move_to_next (filenames))
1271     {
1272         filename = notmuch_filenames_get (filenames);
1273         dir = _filename_is_in_maildir (filename);
1274
1275         if (! dir)
1276             continue;
1277
1278         flags = strstr (filename, ":2,");
1279         if (flags) {
1280             seen_maildir_info = 1;
1281             flags += 3;
1282             combined_flags = talloc_strdup_append (combined_flags, flags);
1283         } else if (STRNCMP_LITERAL (dir, "new/") == 0) {
1284             /* Messages are delivered to new/ with no "info" part, but
1285              * they effectively have default maildir flags.  According
1286              * to the spec, we should ignore the info part for
1287              * messages in new/, but some MUAs (mutt) can set maildir
1288              * flags on messages in new/, so we're liberal in what we
1289              * accept. */
1290             seen_maildir_info = 1;
1291         }
1292     }
1293
1294     /* If none of the filenames have any maildir info field (not even
1295      * an empty info with no flags set) then there's no information to
1296      * go on, so do nothing. */
1297     if (! seen_maildir_info)
1298         return NOTMUCH_STATUS_SUCCESS;
1299
1300     status = notmuch_message_freeze (message);
1301     if (status)
1302         return status;
1303
1304     for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
1305         if ((strchr (combined_flags, flag2tag[i].flag) != NULL)
1306             ^ 
1307             flag2tag[i].inverse)
1308         {
1309             status = notmuch_message_add_tag (message, flag2tag[i].tag);
1310         } else {
1311             status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1312         }
1313         if (status)
1314             return status;
1315     }
1316     status = notmuch_message_thaw (message);
1317
1318     talloc_free (combined_flags);
1319
1320     return status;
1321 }
1322
1323 /* From the set of tags on 'message' and the flag2tag table, compute a
1324  * set of maildir-flag actions to be taken, (flags that should be
1325  * either set or cleared).
1326  *
1327  * The result is returned as two talloced strings: to_set, and to_clear
1328  */
1329 static void
1330 _get_maildir_flag_actions (notmuch_message_t *message,
1331                            char **to_set_ret,
1332                            char **to_clear_ret)
1333 {
1334     char *to_set, *to_clear;
1335     notmuch_tags_t *tags;
1336     const char *tag;
1337     unsigned i;
1338
1339     to_set = talloc_strdup (message, "");
1340     to_clear = talloc_strdup (message, "");
1341
1342     /* First, find flags for all set tags. */
1343     for (tags = notmuch_message_get_tags (message);
1344          notmuch_tags_valid (tags);
1345          notmuch_tags_move_to_next (tags))
1346     {
1347         tag = notmuch_tags_get (tags);
1348
1349         for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1350             if (strcmp (tag, flag2tag[i].tag) == 0) {
1351                 if (flag2tag[i].inverse)
1352                     to_clear = talloc_asprintf_append (to_clear,
1353                                                        "%c",
1354                                                        flag2tag[i].flag);
1355                 else
1356                     to_set = talloc_asprintf_append (to_set,
1357                                                      "%c",
1358                                                      flag2tag[i].flag);
1359             }
1360         }
1361     }
1362
1363     /* Then, find the flags for all tags not present. */
1364     for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1365         if (flag2tag[i].inverse) {
1366             if (strchr (to_clear, flag2tag[i].flag) == NULL)
1367                 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1368         } else {
1369             if (strchr (to_set, flag2tag[i].flag) == NULL)
1370                 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1371         }
1372     }
1373
1374     *to_set_ret = to_set;
1375     *to_clear_ret = to_clear;
1376 }
1377
1378 /* Given 'filename' and a set of maildir flags to set and to clear,
1379  * compute the new maildir filename.
1380  *
1381  * If the existing filename is in the directory "new", the new
1382  * filename will be in the directory "cur", except for the case when
1383  * no flags are changed and the existing filename does not contain
1384  * maildir info (starting with ",2:").
1385  *
1386  * After a sequence of ":2," in the filename, any subsequent
1387  * single-character flags will be added or removed according to the
1388  * characters in flags_to_set and flags_to_clear. Any existing flags
1389  * not mentioned in either string will remain. The final list of flags
1390  * will be in ASCII order.
1391  *
1392  * If the original flags seem invalid, (repeated characters or
1393  * non-ASCII ordering of flags), this function will return NULL
1394  * (meaning that renaming would not be safe and should not occur).
1395  */
1396 static char*
1397 _new_maildir_filename (void *ctx,
1398                        const char *filename,
1399                        const char *flags_to_set,
1400                        const char *flags_to_clear)
1401 {
1402     const char *info, *flags;
1403     unsigned int flag, last_flag;
1404     char *filename_new, *dir;
1405     char flag_map[128];
1406     int flags_in_map = 0;
1407     notmuch_bool_t flags_changed = FALSE;
1408     unsigned int i;
1409     char *s;
1410
1411     memset (flag_map, 0, sizeof (flag_map));
1412
1413     info = strstr (filename, ":2,");
1414
1415     if (info == NULL) {
1416         info = filename + strlen(filename);
1417     } else {
1418         /* Loop through existing flags in filename. */
1419         for (flags = info + 3, last_flag = 0;
1420              *flags;
1421              last_flag = flag, flags++)
1422         {
1423             flag = *flags;
1424
1425             /* Original flags not in ASCII order. Abort. */
1426             if (flag < last_flag)
1427                 return NULL;
1428
1429             /* Non-ASCII flag. Abort. */
1430             if (flag > sizeof(flag_map) - 1)
1431                 return NULL;
1432
1433             /* Repeated flag value. Abort. */
1434             if (flag_map[flag])
1435                 return NULL;
1436
1437             flag_map[flag] = 1;
1438             flags_in_map++;
1439         }
1440     }
1441
1442     /* Then set and clear our flags from tags. */
1443     for (flags = flags_to_set; *flags; flags++) {
1444         flag = *flags;
1445         if (flag_map[flag] == 0) {
1446             flag_map[flag] = 1;
1447             flags_in_map++;
1448             flags_changed = TRUE;
1449         }
1450     }
1451
1452     for (flags = flags_to_clear; *flags; flags++) {
1453         flag = *flags;
1454         if (flag_map[flag]) {
1455             flag_map[flag] = 0;
1456             flags_in_map--;
1457             flags_changed = TRUE;
1458         }
1459     }
1460
1461     /* Messages in new/ without maildir info can be kept in new/ if no
1462      * flags have changed. */
1463     dir = (char *) _filename_is_in_maildir (filename);
1464     if (dir && STRNCMP_LITERAL (dir, "new/") == 0 && !*info && !flags_changed)
1465         return talloc_strdup (ctx, filename);
1466
1467     filename_new = (char *) talloc_size (ctx,
1468                                          info - filename +
1469                                          strlen (":2,") + flags_in_map + 1);
1470     if (unlikely (filename_new == NULL))
1471         return NULL;
1472
1473     strncpy (filename_new, filename, info - filename);
1474     filename_new[info - filename] = '\0';
1475
1476     strcat (filename_new, ":2,");
1477
1478     s = filename_new + strlen (filename_new);
1479     for (i = 0; i < sizeof (flag_map); i++)
1480     {
1481         if (flag_map[i]) {
1482             *s = i;
1483             s++;
1484         }
1485     }
1486     *s = '\0';
1487
1488     /* If message is in new/ move it under cur/. */
1489     dir = (char *) _filename_is_in_maildir (filename_new);
1490     if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1491         memcpy (dir, "cur/", 4);
1492
1493     return filename_new;
1494 }
1495
1496 notmuch_status_t
1497 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
1498 {
1499     notmuch_filenames_t *filenames;
1500     const char *filename;
1501     char *filename_new;
1502     char *to_set, *to_clear;
1503     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1504
1505     _get_maildir_flag_actions (message, &to_set, &to_clear);
1506
1507     for (filenames = notmuch_message_get_filenames (message);
1508          notmuch_filenames_valid (filenames);
1509          notmuch_filenames_move_to_next (filenames))
1510     {
1511         filename = notmuch_filenames_get (filenames);
1512
1513         if (! _filename_is_in_maildir (filename))
1514             continue;
1515
1516         filename_new = _new_maildir_filename (message, filename,
1517                                               to_set, to_clear);
1518         if (filename_new == NULL)
1519             continue;
1520
1521         if (strcmp (filename, filename_new)) {
1522             int err;
1523             notmuch_status_t new_status;
1524
1525             err = rename (filename, filename_new);
1526             if (err)
1527                 continue;
1528
1529             new_status = _notmuch_message_remove_filename (message,
1530                                                            filename);
1531             /* Hold on to only the first error. */
1532             if (! status && new_status
1533                 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
1534                 status = new_status;
1535                 continue;
1536             }
1537
1538             new_status = _notmuch_message_add_filename (message,
1539                                                         filename_new);
1540             /* Hold on to only the first error. */
1541             if (! status && new_status) {
1542                 status = new_status;
1543                 continue;
1544             }
1545
1546             _notmuch_message_sync (message);
1547         }
1548
1549         talloc_free (filename_new);
1550     }
1551
1552     talloc_free (to_set);
1553     talloc_free (to_clear);
1554
1555     return status;
1556 }
1557
1558 notmuch_status_t
1559 notmuch_message_remove_all_tags (notmuch_message_t *message)
1560 {
1561     notmuch_private_status_t private_status;
1562     notmuch_status_t status;
1563     notmuch_tags_t *tags;
1564     const char *tag;
1565
1566     status = _notmuch_database_ensure_writable (message->notmuch);
1567     if (status)
1568         return status;
1569
1570     for (tags = notmuch_message_get_tags (message);
1571          notmuch_tags_valid (tags);
1572          notmuch_tags_move_to_next (tags))
1573     {
1574         tag = notmuch_tags_get (tags);
1575
1576         private_status = _notmuch_message_remove_term (message, "tag", tag);
1577         if (private_status) {
1578             INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1579                             private_status);
1580         }
1581     }
1582
1583     if (! message->frozen)
1584         _notmuch_message_sync (message);
1585
1586     talloc_free (tags);
1587     return NOTMUCH_STATUS_SUCCESS;
1588 }
1589
1590 notmuch_status_t
1591 notmuch_message_freeze (notmuch_message_t *message)
1592 {
1593     notmuch_status_t status;
1594
1595     status = _notmuch_database_ensure_writable (message->notmuch);
1596     if (status)
1597         return status;
1598
1599     message->frozen++;
1600
1601     return NOTMUCH_STATUS_SUCCESS;
1602 }
1603
1604 notmuch_status_t
1605 notmuch_message_thaw (notmuch_message_t *message)
1606 {
1607     notmuch_status_t status;
1608
1609     status = _notmuch_database_ensure_writable (message->notmuch);
1610     if (status)
1611         return status;
1612
1613     if (message->frozen > 0) {
1614         message->frozen--;
1615         if (message->frozen == 0)
1616             _notmuch_message_sync (message);
1617         return NOTMUCH_STATUS_SUCCESS;
1618     } else {
1619         return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
1620     }
1621 }
1622
1623 void
1624 notmuch_message_destroy (notmuch_message_t *message)
1625 {
1626     talloc_free (message);
1627 }