Merge remote branch 'origin/master' into vim
[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 #include <xapian.h>
29
30 struct _notmuch_message {
31     notmuch_database_t *notmuch;
32     Xapian::docid doc_id;
33     int frozen;
34     char *message_id;
35     char *thread_id;
36     char *in_reply_to;
37     char *filename;
38     notmuch_message_file_t *message_file;
39     notmuch_message_list_t *replies;
40     unsigned long flags;
41
42     Xapian::Document doc;
43 };
44
45 /* "128 bits of thread-id ought to be enough for anybody" */
46 #define NOTMUCH_THREAD_ID_BITS   128
47 #define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
48 typedef struct _thread_id {
49     char str[NOTMUCH_THREAD_ID_DIGITS + 1];
50 } thread_id_t;
51
52 /* We end up having to call the destructor explicitly because we had
53  * to use "placement new" in order to initialize C++ objects within a
54  * block that we allocated with talloc. So C++ is making talloc
55  * slightly less simple to use, (we wouldn't need
56  * talloc_set_destructor at all otherwise).
57  */
58 static int
59 _notmuch_message_destructor (notmuch_message_t *message)
60 {
61     message->doc.~Document ();
62
63     return 0;
64 }
65
66 /* Create a new notmuch_message_t object for an existing document in
67  * the database.
68  *
69  * Here, 'talloc owner' is an optional talloc context to which the new
70  * message will belong. This allows for the caller to not bother
71  * calling notmuch_message_destroy on the message, and no that all
72  * memory will be reclaimed with 'talloc_owner' is free. The caller
73  * still can call notmuch_message_destroy when finished with the
74  * message if desired.
75  *
76  * The 'talloc_owner' argument can also be NULL, in which case the
77  * caller *is* responsible for calling notmuch_message_destroy.
78  *
79  * If no document exists in the database with document ID of 'doc_id'
80  * then this function returns NULL and optionally sets *status to
81  * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
82  *
83  * This function can also fail to due lack of available memory,
84  * returning NULL and optionally setting *status to
85  * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
86  *
87  * The caller can pass NULL for status if uninterested in
88  * distinguishing these two cases.
89  */
90 notmuch_message_t *
91 _notmuch_message_create (const void *talloc_owner,
92                          notmuch_database_t *notmuch,
93                          unsigned int doc_id,
94                          notmuch_private_status_t *status)
95 {
96     notmuch_message_t *message;
97
98     if (status)
99         *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
100
101     message = talloc (talloc_owner, notmuch_message_t);
102     if (unlikely (message == NULL)) {
103         if (status)
104             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
105         return NULL;
106     }
107
108     message->notmuch = notmuch;
109     message->doc_id = doc_id;
110
111     message->frozen = 0;
112     message->flags = 0;
113
114     /* Each of these will be lazily created as needed. */
115     message->message_id = NULL;
116     message->thread_id = NULL;
117     message->in_reply_to = NULL;
118     message->filename = NULL;
119     message->message_file = NULL;
120
121     message->replies = _notmuch_message_list_create (message);
122     if (unlikely (message->replies == NULL)) {
123         if (status)
124             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
125         return NULL;
126     }
127
128     /* This is C++'s creepy "placement new", which is really just an
129      * ugly way to call a constructor for a pre-allocated object. So
130      * it's really not an error to not be checking for OUT_OF_MEMORY
131      * here, since this "new" isn't actually allocating memory. This
132      * is language-design comedy of the wrong kind. */
133
134     new (&message->doc) Xapian::Document;
135
136     talloc_set_destructor (message, _notmuch_message_destructor);
137
138     try {
139         message->doc = notmuch->xapian_db->get_document (doc_id);
140     } catch (const Xapian::DocNotFoundError &error) {
141         talloc_free (message);
142         if (status)
143             *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
144         return NULL;
145     }
146
147     return message;
148 }
149
150 /* Create a new notmuch_message_t object for a specific message ID,
151  * (which may or may not already exist in the database).
152  *
153  * The 'notmuch' database will be the talloc owner of the returned
154  * message.
155  *
156  * If there is already a document with message ID 'message_id' in the
157  * database, then the returned message can be used to query/modify the
158  * document. Otherwise, a new document will be inserted into the
159  * database before this function returns, (and *status will be set
160  * to NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND).
161  *
162  * If an error occurs, this function will return NULL and *status
163  * will be set as appropriate. (The status pointer argument must
164  * not be NULL.)
165  */
166 notmuch_message_t *
167 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
168                                         const char *message_id,
169                                         notmuch_private_status_t *status_ret)
170 {
171     notmuch_message_t *message;
172     Xapian::Document doc;
173     Xapian::WritableDatabase *db;
174     unsigned int doc_id;
175     char *term;
176
177     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
178         *status_ret = NOTMUCH_PRIVATE_STATUS_READONLY_DATABASE;
179         return NULL;
180     }
181
182     *status_ret = NOTMUCH_PRIVATE_STATUS_SUCCESS;
183
184     message = notmuch_database_find_message (notmuch, message_id);
185     if (message)
186         return talloc_steal (notmuch, message);
187
188     term = talloc_asprintf (NULL, "%s%s",
189                             _find_prefix ("id"), message_id);
190     if (term == NULL) {
191         *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
192         return NULL;
193     }
194
195     db = static_cast<Xapian::WritableDatabase *> (notmuch->xapian_db);
196     try {
197         doc.add_term (term);
198         talloc_free (term);
199
200         doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
201
202         doc_id = db->add_document (doc);
203     } catch (const Xapian::Error &error) {
204         fprintf (stderr, "A Xapian exception occurred creating message: %s\n",
205                  error.get_msg().c_str());
206         notmuch->exception_reported = TRUE;
207         *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
208         return NULL;
209     }
210
211     message = _notmuch_message_create (notmuch, notmuch,
212                                        doc_id, status_ret);
213
214     /* We want to inform the caller that we had to create a new
215      * document. */
216     if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
217         *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
218
219     return message;
220 }
221
222 const char *
223 notmuch_message_get_message_id (notmuch_message_t *message)
224 {
225     Xapian::TermIterator i;
226
227     if (message->message_id)
228         return message->message_id;
229
230     i = message->doc.termlist_begin ();
231     i.skip_to (_find_prefix ("id"));
232
233     if (i == message->doc.termlist_end ())
234         INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
235                         message->doc_id);
236
237     message->message_id = talloc_strdup (message, (*i).c_str () + 1);
238
239 #if DEBUG_DATABASE_SANITY
240     i++;
241
242     if (i != message->doc.termlist_end () &&
243         strncmp ((*i).c_str (), _find_prefix ("id"),
244                  strlen (_find_prefix ("id"))) == 0)
245     {
246         INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
247                         message->doc_id);
248     }
249 #endif
250
251     return message->message_id;
252 }
253
254 static void
255 _notmuch_message_ensure_message_file (notmuch_message_t *message)
256 {
257     const char *filename;
258
259     if (message->message_file)
260         return;
261
262     filename = notmuch_message_get_filename (message);
263     if (unlikely (filename == NULL))
264         return;
265
266     message->message_file = _notmuch_message_file_open_ctx (message, filename);
267 }
268
269 const char *
270 notmuch_message_get_header (notmuch_message_t *message, const char *header)
271 {
272     _notmuch_message_ensure_message_file (message);
273     if (message->message_file == NULL)
274         return NULL;
275
276     return notmuch_message_file_get_header (message->message_file, header);
277 }
278
279 /* Return the message ID from the In-Reply-To header of 'message'.
280  *
281  * Returns an empty string ("") if 'message' has no In-Reply-To
282  * header.
283  *
284  * Returns NULL if any error occurs.
285  */
286 const char *
287 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
288 {
289     const char *prefix = _find_prefix ("replyto");
290     int prefix_len = strlen (prefix);
291     Xapian::TermIterator i;
292     std::string in_reply_to;
293
294     if (message->in_reply_to)
295         return message->in_reply_to;
296
297     i = message->doc.termlist_begin ();
298     i.skip_to (prefix);
299
300     if (i != message->doc.termlist_end ())
301         in_reply_to = *i;
302
303     /* It's perfectly valid for a message to have no In-Reply-To
304      * header. For these cases, we return an empty string. */
305     if (i == message->doc.termlist_end () ||
306         strncmp (in_reply_to.c_str (), prefix, prefix_len))
307     {
308         message->in_reply_to = talloc_strdup (message, "");
309         return message->in_reply_to;
310     }
311
312     message->in_reply_to = talloc_strdup (message,
313                                           in_reply_to.c_str () + prefix_len);
314
315 #if DEBUG_DATABASE_SANITY
316     i++;
317
318     in_reply_to = *i;
319
320     if (i != message->doc.termlist_end () &&
321         strncmp ((*i).c_str (), prefix, prefix_len))
322     {
323         INTERNAL_ERROR ("Message %s has duplicate In-Reply-To IDs: %s and %s\n"
324                         notmuch_message_get_message_id (message),
325                         message->in_reply_to,
326                         (*i).c_str () + prefix_len);
327     }
328 #endif
329
330     return message->in_reply_to;
331 }
332
333 const char *
334 notmuch_message_get_thread_id (notmuch_message_t *message)
335 {
336     const char *prefix = _find_prefix ("thread");
337     Xapian::TermIterator i;
338     std::string id;
339
340     /* This code is written with the assumption that "thread" has a
341      * single-character prefix. */
342     assert (strlen (prefix) == 1);
343
344     if (message->thread_id)
345         return message->thread_id;
346
347     i = message->doc.termlist_begin ();
348     i.skip_to (prefix);
349
350     if (i != message->doc.termlist_end ())
351         id = *i;
352
353     if (i == message->doc.termlist_end () || id[0] != *prefix)
354         INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
355                         message->doc_id);
356
357     message->thread_id = talloc_strdup (message, id.c_str () + 1);
358
359 #if DEBUG_DATABASE_SANITY
360     i++;
361     id = *i;
362
363     if (i != message->doc.termlist_end () && id[0] == *prefix)
364     {
365         INTERNAL_ERROR ("Message %s has duplicate thread IDs: %s and %s\n",
366                         notmuch_message_get_message_id (message),
367                         message->thread_id,
368                         id.c_str () + 1);
369     }
370 #endif
371
372     return message->thread_id;
373 }
374
375 void
376 _notmuch_message_add_reply (notmuch_message_t *message,
377                             notmuch_message_node_t *reply)
378 {
379     _notmuch_message_list_append (message->replies, reply);
380 }
381
382 notmuch_messages_t *
383 notmuch_message_get_replies (notmuch_message_t *message)
384 {
385     return _notmuch_messages_create (message->replies);
386 }
387
388 /* Set the filename for 'message' to 'filename'.
389  *
390  * XXX: We should still figure out if we think it's important to store
391  * multiple filenames for email messages with identical message IDs.
392  *
393  * This change will not be reflected in the database until the next
394  * call to _notmuch_message_set_sync. */
395 void
396 _notmuch_message_set_filename (notmuch_message_t *message,
397                                const char *filename)
398 {
399     const char *s;
400     const char *db_path;
401     unsigned int db_path_len;
402
403     if (message->filename) {
404         talloc_free (message->filename);
405         message->filename = NULL;
406     }
407
408     if (filename == NULL)
409         INTERNAL_ERROR ("Message filename cannot be NULL.");
410
411     s = filename;
412
413     db_path = notmuch_database_get_path (message->notmuch);
414     db_path_len = strlen (db_path);
415
416     if (*s == '/' && strlen (s) > db_path_len
417         && strncmp (s, db_path, db_path_len) == 0)
418     {
419         s += db_path_len;
420         while (*s == '/') s++;
421
422         if (!*s)
423                 INTERNAL_ERROR ("Message filename was same as db prefix.");
424     }
425
426     message->doc.set_data (s);
427 }
428
429 const char *
430 notmuch_message_get_filename (notmuch_message_t *message)
431 {
432     std::string filename_str;
433     const char *db_path;
434
435     if (message->filename)
436         return message->filename;
437
438     filename_str = message->doc.get_data ();
439     db_path = notmuch_database_get_path (message->notmuch);
440
441     if (filename_str[0] != '/')
442         message->filename = talloc_asprintf (message, "%s/%s", db_path,
443                                              filename_str.c_str ());
444     else
445         message->filename = talloc_strdup (message, filename_str.c_str ());
446
447     return message->filename;
448 }
449
450 notmuch_bool_t
451 notmuch_message_get_flag (notmuch_message_t *message,
452                           notmuch_message_flag_t flag)
453 {
454     return message->flags & (1 << flag);
455 }
456
457 void
458 notmuch_message_set_flag (notmuch_message_t *message,
459                           notmuch_message_flag_t flag, notmuch_bool_t enable)
460 {
461     if (enable)
462         message->flags |= (1 << flag);
463     else
464         message->flags &= ~(1 << flag);
465 }
466
467 time_t
468 notmuch_message_get_date (notmuch_message_t *message)
469 {
470     std::string value;
471
472     try {
473         value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
474     } catch (Xapian::Error &error) {
475         INTERNAL_ERROR ("Failed to read timestamp value from document.");
476         return 0;
477     }
478
479     return Xapian::sortable_unserialise (value);
480 }
481
482 notmuch_tags_t *
483 notmuch_message_get_tags (notmuch_message_t *message)
484 {
485     Xapian::TermIterator i, end;
486     i = message->doc.termlist_begin();
487     end = message->doc.termlist_end();
488     return _notmuch_convert_tags(message, i, end);
489 }
490
491 void
492 _notmuch_message_set_date (notmuch_message_t *message,
493                            const char *date)
494 {
495     time_t time_value;
496
497     /* GMime really doesn't want to see a NULL date, so protect its
498      * sensibilities. */
499     if (date == NULL || *date == '\0')
500         time_value = 0;
501     else
502         time_value = g_mime_utils_header_decode_date (date, NULL);
503
504     message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
505                             Xapian::sortable_serialise (time_value));
506 }
507
508 static void
509 thread_id_generate (thread_id_t *thread_id)
510 {
511     static int seeded = 0;
512     FILE *dev_random;
513     uint32_t value;
514     char *s;
515     int i;
516
517     if (! seeded) {
518         dev_random = fopen ("/dev/random", "r");
519         if (dev_random == NULL) {
520             srand (time (NULL));
521         } else {
522             fread ((void *) &value, sizeof (value), 1, dev_random);
523             srand (value);
524             fclose (dev_random);
525         }
526         seeded = 1;
527     }
528
529     s = thread_id->str;
530     for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
531         value = rand ();
532         sprintf (s, "%08x", value);
533         s += 8;
534     }
535 }
536
537 void
538 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
539 {
540     /* If not part of any existing thread, generate a new thread_id. */
541     thread_id_t thread_id;
542
543     thread_id_generate (&thread_id);
544     _notmuch_message_add_term (message, "thread", thread_id.str);
545 }
546
547 /* Synchronize changes made to message->doc out into the database. */
548 void
549 _notmuch_message_sync (notmuch_message_t *message)
550 {
551     Xapian::WritableDatabase *db;
552
553     if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
554         return;
555
556     db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
557     db->replace_document (message->doc_id, message->doc);
558 }
559
560 /* Ensure that 'message' is not holding any file object open. Future
561  * calls to various functions will still automatically open the
562  * message file as needed.
563  */
564 void
565 _notmuch_message_close (notmuch_message_t *message)
566 {
567     if (message->message_file) {
568         notmuch_message_file_close (message->message_file);
569         message->message_file = NULL;
570     }
571 }
572
573 /* Add a name:value term to 'message', (the actual term will be
574  * encoded by prefixing the value with a short prefix). See
575  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
576  * names to prefix values.
577  *
578  * This change will not be reflected in the database until the next
579  * call to _notmuch_message_set_sync. */
580 notmuch_private_status_t
581 _notmuch_message_add_term (notmuch_message_t *message,
582                            const char *prefix_name,
583                            const char *value)
584 {
585
586     char *term;
587
588     if (value == NULL)
589         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
590
591     term = talloc_asprintf (message, "%s%s",
592                             _find_prefix (prefix_name), value);
593
594     if (strlen (term) > NOTMUCH_TERM_MAX)
595         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
596
597     message->doc.add_term (term);
598
599     talloc_free (term);
600
601     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
602 }
603
604 /* Parse 'text' and add a term to 'message' for each parsed word. Each
605  * term will be added both prefixed (if prefix_name is not NULL) and
606  * also unprefixed). */
607 notmuch_private_status_t
608 _notmuch_message_gen_terms (notmuch_message_t *message,
609                             const char *prefix_name,
610                             const char *text)
611 {
612     Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
613
614     if (text == NULL)
615         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
616
617     term_gen->set_document (message->doc);
618
619     if (prefix_name) {
620         const char *prefix = _find_prefix (prefix_name);
621
622         term_gen->index_text (text, 1, prefix);
623     }
624
625     term_gen->index_text (text);
626
627     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
628 }
629
630 /* Remove a name:value term from 'message', (the actual term will be
631  * encoded by prefixing the value with a short prefix). See
632  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
633  * names to prefix values.
634  *
635  * This change will not be reflected in the database until the next
636  * call to _notmuch_message_set_sync. */
637 notmuch_private_status_t
638 _notmuch_message_remove_term (notmuch_message_t *message,
639                               const char *prefix_name,
640                               const char *value)
641 {
642     char *term;
643
644     if (value == NULL)
645         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
646
647     term = talloc_asprintf (message, "%s%s",
648                             _find_prefix (prefix_name), value);
649
650     if (strlen (term) > NOTMUCH_TERM_MAX)
651         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
652
653     try {
654         message->doc.remove_term (term);
655     } catch (const Xapian::InvalidArgumentError) {
656         /* We'll let the philosopher's try to wrestle with the
657          * question of whether failing to remove that which was not
658          * there in the first place is failure. For us, we'll silently
659          * consider it all good. */
660     }
661
662     talloc_free (term);
663
664     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
665 }
666
667 notmuch_status_t
668 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
669 {
670     notmuch_private_status_t status;
671
672     if (tag == NULL)
673         return NOTMUCH_STATUS_NULL_POINTER;
674
675     if (strlen (tag) > NOTMUCH_TAG_MAX)
676         return NOTMUCH_STATUS_TAG_TOO_LONG;
677
678     status = _notmuch_message_add_term (message, "tag", tag);
679     if (status) {
680         INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
681                         status);
682     }
683
684     if (! message->frozen)
685         _notmuch_message_sync (message);
686
687     return NOTMUCH_STATUS_SUCCESS;
688 }
689
690 notmuch_status_t
691 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
692 {
693     notmuch_private_status_t status;
694
695     if (tag == NULL)
696         return NOTMUCH_STATUS_NULL_POINTER;
697
698     if (strlen (tag) > NOTMUCH_TAG_MAX)
699         return NOTMUCH_STATUS_TAG_TOO_LONG;
700
701     status = _notmuch_message_remove_term (message, "tag", tag);
702     if (status) {
703         INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
704                         status);
705     }
706
707     if (! message->frozen)
708         _notmuch_message_sync (message);
709
710     return NOTMUCH_STATUS_SUCCESS;
711 }
712
713 void
714 notmuch_message_remove_all_tags (notmuch_message_t *message)
715 {
716     notmuch_private_status_t status;
717     notmuch_tags_t *tags;
718     const char *tag;
719
720     for (tags = notmuch_message_get_tags (message);
721          notmuch_tags_has_more (tags);
722          notmuch_tags_advance (tags))
723     {
724         tag = notmuch_tags_get (tags);
725
726         status = _notmuch_message_remove_term (message, "tag", tag);
727         if (status) {
728             INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
729                             status);
730         }
731     }
732
733     if (! message->frozen)
734         _notmuch_message_sync (message);
735 }
736
737 void
738 notmuch_message_freeze (notmuch_message_t *message)
739 {
740     message->frozen++;
741 }
742
743 notmuch_status_t
744 notmuch_message_thaw (notmuch_message_t *message)
745 {
746     if (message->frozen > 0) {
747         message->frozen--;
748         if (message->frozen == 0)
749             _notmuch_message_sync (message);
750         return NOTMUCH_STATUS_SUCCESS;
751     } else {
752         return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
753     }
754 }
755
756 void
757 notmuch_message_destroy (notmuch_message_t *message)
758 {
759     talloc_free (message);
760 }