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     char *message_id;
  30     char *filename;
  31     Xapian::Document doc;
  32 };
  33
  34 struct _notmuch_tags {
  35     Xapian::TermIterator iterator;
  36     Xapian::TermIterator iterator_end;
  37 };
  38
  39 struct _notmuch_thread_ids {
  40     char *current;
  41     char *next;
  42 };
  43
  44 /* "128 bits of thread-id ought to be enough for anybody" */
  45 #define NOTMUCH_THREAD_ID_BITS   128
  46 #define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
  47 typedef struct _thread_id {
  48     char str[NOTMUCH_THREAD_ID_DIGITS + 1];
  49 } thread_id_t;
  50
  51 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
  52
  53 /* These prefix values are specifically chosen to be compatible
  54  * with sup, (http://sup.rubyforge.org), written by
  55  * William Morgan <wmorgan-sup@masanjin.net>, and released
  56  * under the GNU GPL v2.
  57  */
  58
  59 typedef struct {
  60     const char *name;
  61     const char *prefix;
  62 } prefix_t;
  63
  64 prefix_t NORMAL_PREFIX[] = {
  65     { "subject", "S" },
  66     { "body", "B" },
  67     { "from_name", "FN" },
  68     { "to_name", "TN" },
  69     { "name", "N" },
  70     { "attachment", "A" }
  71 };
  72
  73 prefix_t BOOLEAN_PREFIX[] = {
  74     { "type", "K" },
  75     { "from_email", "FE" },
  76     { "to_email", "TE" },
  77     { "email", "E" },
  78     { "date", "D" },
  79     { "label", "L" },
  80     { "tag", "L" },
  81     { "source_id", "I" },
  82     { "attachment_extension", "O" },
  83     { "msgid", "Q" },
  84     { "thread", "H" },
  85     { "ref", "R" }
  86 };
  87
  88 const char *
  89 _find_prefix (const char *name)
  90 {
  91     unsigned int i;
  92
  93     for (i = 0; i < ARRAY_SIZE (NORMAL_PREFIX); i++)
  94         if (strcmp (name, NORMAL_PREFIX[i].name) == 0)
  95             return NORMAL_PREFIX[i].prefix;
  96
  97     for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX); i++)
  98         if (strcmp (name, BOOLEAN_PREFIX[i].name) == 0)
  99             return BOOLEAN_PREFIX[i].prefix;
 100
 101     return "";
 102 }
 103
 104 /* We end up having to call the destructor explicitly because we had
 105  * to use "placement new" in order to initialize C++ objects within a
 106  * block that we allocated with talloc. So C++ is making talloc
 107  * slightly less simple to use, (we wouldn't need
 108  * talloc_set_destructor at all otherwise).
 109  */
 110 static int
 111 _notmuch_message_destructor (notmuch_message_t *message)
 112 {
 113     message->doc.~Document ();
 114
 115     return 0;
 116 }
 117
 118 /* Create a new notmuch_message_t object for an existing document in
 119  * the database.
 120  *
 121  * Here, 'talloc owner' is an optional talloc context to which the new
 122  * message will belong. This allows for the caller to not bother
 123  * calling notmuch_message_destroy on the message, and no that all
 124  * memory will be reclaimed with 'talloc_owner' is free. The caller
 125  * still can call notmuch_message_destroy when finished with the
 126  * message if desired.
 127  *
 128  * The 'talloc_owner' argument can also be NULL, in which case the
 129  * caller *is* responsible for calling notmuch_message_destroy.
 130  *
 131  * If no document exists in the database with document ID of 'doc_id'
 132  * then this function returns NULL.
 133  */
 134 notmuch_message_t *
 135 _notmuch_message_create (const void *talloc_owner,
 136                          notmuch_database_t *notmuch,
 137                          unsigned int doc_id)
 138 {
 139     notmuch_message_t *message;
 140
 141     message = talloc (talloc_owner, notmuch_message_t);
 142     if (unlikely (message == NULL))
 143         return NULL;
 144
 145     message->notmuch = notmuch;
 146     message->doc_id = doc_id;
 147     message->message_id = NULL; /* lazily created */
 148     message->filename = NULL; /* lazily created */
 149     new (&message->doc) Xapian::Document;
 150
 151     talloc_set_destructor (message, _notmuch_message_destructor);
 152
 153     try {
 154         message->doc = notmuch->xapian_db->get_document (doc_id);
 155     } catch (const Xapian::DocNotFoundError &error) {
 156         talloc_free (message);
 157         return NULL;
 158     }
 159
 160     return message;
 161 }
 162
 163 /* Create a new notmuch_message_t object for a specific message ID,
 164  * (which may or may not already exist in the databas).
 165  *
 166  * Here, 'talloc owner' is an optional talloc context to which the new
 167  * message will belong. This allows for the caller to not bother
 168  * calling notmuch_message_destroy on the message, and no that all
 169  * memory will be reclaimed with 'talloc_owner' is free. The caller
 170  * still can call notmuch_message_destroy when finished with the
 171  * message if desired.
 172  *
 173  * The 'talloc_owner' argument can also be NULL, in which case the
 174  * caller *is* responsible for calling notmuch_message_destroy.
 175  *
 176  * If there is already a document with message ID 'message_id' in the
 177  * database, then the returned message can be used to query/modify the
 178  * document. Otherwise, a new document will be inserted into the
 179  * database before this function returns;
 180  */
 181 notmuch_message_t *
 182 _notmuch_message_create_for_message_id (const void *talloc_owner,
 183                                         notmuch_database_t *notmuch,
 184                                         const char *message_id)
 185 {
 186     notmuch_message_t *message;
 187     Xapian::Document doc;
 188     unsigned int doc_id;
 189     char *term;
 190
 191     message = notmuch_database_find_message (notmuch, message_id);
 192     if (message)
 193         return talloc_steal (talloc_owner, message);
 194
 195     term = talloc_asprintf (NULL, "%s%s",
 196                             _find_prefix ("msgid"), message_id);
 197     doc.add_term (term);
 198     talloc_free (term);
 199
 200     doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
 201
 202     doc_id = notmuch->xapian_db->add_document (doc);
 203
 204     return _notmuch_message_create (talloc_owner, notmuch, doc_id);
 205 }
 206
 207 const char *
 208 notmuch_message_get_message_id (notmuch_message_t *message)
 209 {
 210     Xapian::TermIterator i;
 211
 212     if (message->message_id)
 213         return message->message_id;
 214
 215     i = message->doc.termlist_begin ();
 216     i.skip_to (_find_prefix ("msgid"));
 217
 218     /* XXX: This should really be an internal error, but we'll need to
 219      * fix the add_message side of things first. */
 220     if (i == message->doc.termlist_end ())
 221         return NULL;
 222
 223     message->message_id = talloc_strdup (message, (*i).c_str () + 1);
 224     return message->message_id;
 225 }
 226
 227 /* Set the filename for 'message' to 'filename'.
 228  *
 229  * XXX: We should still figure out what we want to do for multiple
 230  * files with identical message IDs. We will probably want to store a
 231  * list of filenames here, (so that this will be "add_filename"
 232  * instead of "set_filename"). Which would make this very similar to
 233  * add_thread_ids.
 234  *
 235  * This change will not be reflected in the database until the next
 236  * call to _notmuch_message_set_sync. */
 237 void
 238 _notmuch_message_set_filename (notmuch_message_t *message,
 239                                const char *filename)
 240 {
 241     if (message->filename)
 242         talloc_free (message->filename);
 243     message->doc.set_data (filename);
 244 }
 245
 246 const char *
 247 notmuch_message_get_filename (notmuch_message_t *message)
 248 {
 249     std::string filename_str;
 250
 251     if (message->filename)
 252         return message->filename;
 253
 254     filename_str = message->doc.get_data ();
 255     message->filename = talloc_strdup (message, filename_str.c_str ());
 256
 257     return message->filename;
 258 }
 259
 260 /* We end up having to call the destructors explicitly because we had
 261  * to use "placement new" in order to initialize C++ objects within a
 262  * block that we allocated with talloc. So C++ is making talloc
 263  * slightly less simple to use, (we wouldn't need
 264  * talloc_set_destructor at all otherwise).
 265  */
 266 static int
 267 _notmuch_tags_destructor (notmuch_tags_t *tags)
 268 {
 269     tags->iterator.~TermIterator ();
 270     tags->iterator_end.~TermIterator ();
 271
 272     return 0;
 273 }
 274
 275 notmuch_tags_t *
 276 notmuch_message_get_tags (notmuch_message_t *message)
 277 {
 278     notmuch_tags_t *tags;
 279
 280     tags = talloc (message, notmuch_tags_t);
 281     if (unlikely (tags == NULL))
 282         return NULL;
 283
 284     new (&tags->iterator) Xapian::TermIterator;
 285     new (&tags->iterator_end) Xapian::TermIterator;
 286
 287     talloc_set_destructor (tags, _notmuch_tags_destructor);
 288
 289     tags->iterator = message->doc.termlist_begin ();
 290     tags->iterator.skip_to (_find_prefix ("tag"));
 291     tags->iterator_end = message->doc.termlist_end ();
 292
 293     return tags;
 294 }
 295
 296 notmuch_thread_ids_t *
 297 notmuch_message_get_thread_ids (notmuch_message_t *message)
 298 {
 299     notmuch_thread_ids_t *thread_ids;
 300     std::string id_str;
 301
 302     thread_ids = talloc (message, notmuch_thread_ids_t);
 303     if (unlikely (thread_ids == NULL))
 304         return NULL;
 305
 306     id_str = message->doc.get_value (NOTMUCH_VALUE_THREAD);
 307     thread_ids->next = talloc_strdup (message, id_str.c_str ());
 308
 309     /* Initialize thread_ids->current and terminate first ID. */
 310     notmuch_thread_ids_advance (thread_ids);
 311
 312     return thread_ids;
 313 }
 314
 315 void
 316 _notmuch_message_set_date (notmuch_message_t *message,
 317                            const char *date)
 318 {
 319     time_t time_value;
 320
 321     time_value = notmuch_parse_date (date, NULL);
 322
 323     message->doc.add_value (NOTMUCH_VALUE_DATE,
 324                             Xapian::sortable_serialise (time_value));
 325 }
 326
 327 void
 328 _notmuch_message_add_thread_id (notmuch_message_t *message,
 329                                 const char *thread_id)
 330 {
 331     std::string id_str;
 332
 333     _notmuch_message_add_term (message, "thread", thread_id);
 334
 335     id_str = message->doc.get_value (NOTMUCH_VALUE_THREAD);
 336
 337     if (id_str.empty ()) {
 338         message->doc.add_value (NOTMUCH_VALUE_THREAD, thread_id);
 339     } else {
 340         size_t pos;
 341
 342         /* Think about using a hash here if there's any performance
 343          * problem. */
 344         pos = id_str.find (thread_id);
 345         if (pos == std::string::npos) {
 346             id_str.append (",");
 347             id_str.append (thread_id);
 348             message->doc.add_value (NOTMUCH_VALUE_THREAD, id_str);
 349         }
 350     }
 351 }
 352
 353 static void
 354 thread_id_generate (thread_id_t *thread_id)
 355 {
 356     static int seeded = 0;
 357     FILE *dev_random;
 358     uint32_t value;
 359     char *s;
 360     int i;
 361
 362     if (! seeded) {
 363         dev_random = fopen ("/dev/random", "r");
 364         if (dev_random == NULL) {
 365             srand (time (NULL));
 366         } else {
 367             fread ((void *) &value, sizeof (value), 1, dev_random);
 368             srand (value);
 369             fclose (dev_random);
 370         }
 371         seeded = 1;
 372     }
 373
 374     s = thread_id->str;
 375     for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
 376         value = rand ();
 377         sprintf (s, "%08x", value);
 378         s += 8;
 379     }
 380 }
 381
 382 void
 383 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
 384 {
 385     /* If not part of any existing thread, generate a new thread_id. */
 386     thread_id_t thread_id;
 387
 388     thread_id_generate (&thread_id);
 389     _notmuch_message_add_term (message, "thread", thread_id.str);
 390     message->doc.add_value (NOTMUCH_VALUE_THREAD, thread_id.str);
 391 }
 392
 393 /* Synchronize changes made to message->doc out into the database. */
 394 void
 395 _notmuch_message_sync (notmuch_message_t *message)
 396 {
 397     Xapian::WritableDatabase *db = message->notmuch->xapian_db;
 398
 399     db->replace_document (message->doc_id, message->doc);
 400 }
 401
 402 /* Add a name:value term to 'message', (the actual term will be
 403  * encoded by prefixing the value with a short prefix). See
 404  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
 405  * names to prefix values.
 406  *
 407  * This change will not be reflected in the database until the next
 408  * call to _notmuch_message_set_sync. */
 409 notmuch_private_status_t
 410 _notmuch_message_add_term (notmuch_message_t *message,
 411                            const char *prefix_name,
 412                            const char *value)
 413 {
 414
 415     char *term;
 416
 417     if (value == NULL)
 418         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
 419
 420     term = talloc_asprintf (message, "%s%s",
 421                             _find_prefix (prefix_name), value);
 422
 423     if (strlen (term) > NOTMUCH_TERM_MAX)
 424         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 425
 426     message->doc.add_term (term);
 427
 428     talloc_free (term);
 429
 430     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 431 }
 432
 433 /* Remove a name:value term from 'message', (the actual term will be
 434  * encoded by prefixing the value with a short prefix). See
 435  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
 436  * names to prefix values.
 437  *
 438  * This change will not be reflected in the database until the next
 439  * call to _notmuch_message_set_sync. */
 440 notmuch_private_status_t
 441 _notmuch_message_remove_term (notmuch_message_t *message,
 442                               const char *prefix_name,
 443                               const char *value)
 444 {
 445     char *term;
 446
 447     if (value == NULL)
 448         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
 449
 450     term = talloc_asprintf (message, "%s%s",
 451                             _find_prefix (prefix_name), value);
 452
 453     if (strlen (term) > NOTMUCH_TERM_MAX)
 454         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 455
 456     message->doc.remove_term (term);
 457
 458     talloc_free (term);
 459
 460     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 461 }
 462
 463 notmuch_status_t
 464 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
 465 {
 466     notmuch_private_status_t status;
 467
 468     if (tag == NULL)
 469         return NOTMUCH_STATUS_NULL_POINTER;
 470
 471     if (strlen (tag) > NOTMUCH_TAG_MAX)
 472         return NOTMUCH_STATUS_TAG_TOO_LONG;
 473
 474     status = _notmuch_message_add_term (message, "tag", tag);
 475     if (status) {
 476         fprintf (stderr, "Internal error: _notmuch_message_add_term return unexpected value: %d\n",
 477                  status);
 478         exit (1);
 479     }
 480
 481     _notmuch_message_sync (message);
 482
 483     return NOTMUCH_STATUS_SUCCESS;
 484 }
 485
 486 notmuch_status_t
 487 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
 488 {
 489     notmuch_private_status_t status;
 490
 491     if (tag == NULL)
 492         return NOTMUCH_STATUS_NULL_POINTER;
 493
 494     if (strlen (tag) > NOTMUCH_TAG_MAX)
 495         return NOTMUCH_STATUS_TAG_TOO_LONG;
 496
 497     status = _notmuch_message_remove_term (message, "tag", tag);
 498     if (status) {
 499         fprintf (stderr, "Internal error: _notmuch_message_remove_term return unexpected value: %d\n",
 500                  status);
 501         exit (1);
 502     }
 503
 504     _notmuch_message_sync (message);
 505
 506     return NOTMUCH_STATUS_SUCCESS;
 507 }
 508
 509 void
 510 notmuch_message_destroy (notmuch_message_t *message)
 511 {
 512     talloc_free (message);
 513 }
 514
 515 notmuch_bool_t
 516 notmuch_tags_has_more (notmuch_tags_t *tags)
 517 {
 518     std::string s;
 519
 520     if (tags->iterator == tags->iterator_end)
 521         return FALSE;
 522
 523     s = *tags->iterator;
 524     if (s.size () && s[0] == 'L')
 525         return TRUE;
 526     else
 527         return FALSE;
 528 }
 529
 530 const char *
 531 notmuch_tags_get (notmuch_tags_t *tags)
 532 {
 533     return talloc_strdup (tags, (*tags->iterator).c_str () + 1);
 534 }
 535
 536 void
 537 notmuch_tags_advance (notmuch_tags_t *tags)
 538 {
 539     tags->iterator++;
 540 }
 541
 542 void
 543 notmuch_tags_destroy (notmuch_tags_t *tags)
 544 {
 545     talloc_free (tags);
 546 }
 547
 548 notmuch_bool_t
 549 notmuch_thread_ids_has_more (notmuch_thread_ids_t *thread_ids)
 550 {
 551     if (thread_ids->current == NULL || *thread_ids->current == '\0')
 552         return FALSE;
 553     else
 554         return TRUE;
 555 }
 556
 557 const char *
 558 notmuch_thread_ids_get (notmuch_thread_ids_t *thread_ids)
 559 {
 560     return thread_ids->current;
 561 }
 562
 563 void
 564 notmuch_thread_ids_advance (notmuch_thread_ids_t *thread_ids)
 565 {
 566     thread_ids->current = strsep (&thread_ids->next, ",");
 567 }
 568
 569 void
 570 notmuch_thread_ids_destroy (notmuch_thread_ids_t *thread_ids)
 571 {
 572     talloc_free (thread_ids);
 573 }