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