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