git.notmuchmail.org Git - notmuch/blob - notmuch-index-message.cc

   1 /*
   2  * Copyright © 2009 Carl Worth
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see http://www.gnu.org/licenses/ .
  16  *
  17  * Author: Carl Worth <cworth@cworth.org>
  18  */
  19
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <errno.h>
  24 #include <time.h>
  25
  26 #include <iostream>
  27
  28 #include <gmime/gmime.h>
  29
  30 #include <xapian.h>
  31
  32 using namespace std;
  33
  34 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
  35
  36 /* Xapian complains if we provide a term longer than this. */
  37 #define NOTMUCH_MAX_TERM 245
  38
  39 /* These prefix values are specifically chosen to be compatible
  40  * with sup, (http://sup.rubyforge.org), written by
  41  * William Morgan <wmorgan-sup@masanjin.net>, and released
  42  * under the GNU GPL v2.
  43  */
  44
  45 typedef struct {
  46     const char *name;
  47     const char *prefix;
  48 } prefix_t;
  49
  50 prefix_t NORMAL_PREFIX[] = {
  51     { "subject", "S" },
  52     { "body", "B" },
  53     { "from_name", "FN" },
  54     { "to_name", "TN" },
  55     { "name", "N" },
  56     { "attachment", "A" }
  57 };
  58
  59 prefix_t BOOLEAN_PREFIX[] = {
  60     { "type", "K" },
  61     { "from_email", "FE" },
  62     { "to_email", "TE" },
  63     { "email", "E" },
  64     { "date", "D" },
  65     { "label", "L" },
  66     { "source_id", "I" },
  67     { "attachment_extension", "O" },
  68     { "msgid", "Q" },
  69     { "thread", "H" },
  70     { "ref", "R" }
  71 };
  72
  73 /* Similarly, these value numbers are also chosen to be sup
  74  * compatible. */
  75
  76 typedef enum {
  77     NOTMUCH_VALUE_MESSAGE_ID = 0,
  78     NOTMUCH_VALUE_THREAD = 1,
  79     NOTMUCH_VALUE_DATE = 2
  80 } notmuch_value_t;
  81
  82 static const char *
  83 find_prefix (const char *name)
  84 {
  85     unsigned int i;
  86
  87     for (i = 0; i < ARRAY_SIZE (NORMAL_PREFIX); i++)
  88         if (strcmp (name, NORMAL_PREFIX[i].name) == 0)
  89             return NORMAL_PREFIX[i].prefix;
  90
  91     for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX); i++)
  92         if (strcmp (name, BOOLEAN_PREFIX[i].name) == 0)
  93             return BOOLEAN_PREFIX[i].prefix;
  94
  95     return "";
  96 }
  97
  98 int TERM_COMBINED = 0;
  99
 100 static void
 101 add_term (Xapian::Document doc,
 102           const char *prefix_name,
 103           const char *value)
 104 {
 105     const char *prefix;
 106     char *term;
 107
 108     if (value == NULL)
 109         return;
 110
 111     prefix = find_prefix (prefix_name);
 112
 113     term = g_strdup_printf ("%s%s", prefix, value);
 114
 115     if (strlen (term) <= NOTMUCH_MAX_TERM)
 116         doc.add_term (term);
 117
 118     g_free (term);
 119 }
 120
 121 static void
 122 gen_terms (Xapian::TermGenerator term_gen,
 123            const char *prefix_name,
 124            const char *text)
 125 {
 126     const char *prefix;
 127
 128     if (text == NULL)
 129         return;
 130
 131     prefix = find_prefix (prefix_name);
 132
 133     term_gen.index_text (text, 1, prefix);
 134 }
 135
 136 static void
 137 gen_terms_address_name (Xapian::TermGenerator term_gen,
 138                         InternetAddress *address,
 139                         const char *prefix_name)
 140 {
 141     const char *name;
 142     int own_name = 0;
 143
 144     name = internet_address_get_name (address);
 145
 146     /* In the absence of a name, we'll strip the part before the @
 147      * from the address. */
 148     if (! name) {
 149         InternetAddressMailbox *mailbox = INTERNET_ADDRESS_MAILBOX (address);
 150         const char *addr = internet_address_mailbox_get_addr (mailbox);
 151         const char *at;
 152
 153         at = strchr (addr, '@');
 154         if (at) {
 155             name = strndup (addr, at - addr);
 156             own_name = 1;
 157         }
 158     }
 159
 160     if (name)
 161         gen_terms (term_gen, prefix_name, name);
 162
 163     if (own_name)
 164         free ((void *) name);
 165 }
 166
 167 static void
 168 gen_terms_address_names (Xapian::TermGenerator term_gen,
 169                          InternetAddressList *addresses,
 170                          const char *address_type)
 171 {
 172     int i;
 173     InternetAddress *address;
 174
 175     for (i = 0; i < internet_address_list_length (addresses); i++) {
 176         address = internet_address_list_get_address (addresses, i);
 177         gen_terms_address_name (term_gen, address, address_type);
 178         gen_terms_address_name (term_gen, address, "name");
 179         gen_terms_address_name (term_gen, address, "body");
 180     }
 181 }
 182
 183 static void
 184 add_term_address_addr (Xapian::Document doc,
 185                        InternetAddress *address,
 186                        const char *prefix_name)
 187 {
 188     InternetAddressMailbox *mailbox = INTERNET_ADDRESS_MAILBOX (address);
 189     const char *addr;
 190
 191     addr = internet_address_mailbox_get_addr (mailbox);
 192
 193     if (addr)
 194         add_term (doc, prefix_name, addr);
 195 }
 196
 197 static void
 198 add_terms_address_addrs (Xapian::Document doc,
 199                          InternetAddressList *addresses,
 200                          const char *address_type)
 201 {
 202     int i;
 203     InternetAddress *address;
 204
 205     for (i = 0; i < internet_address_list_length (addresses); i++) {
 206         address = internet_address_list_get_address (addresses, i);
 207         add_term_address_addr (doc, address, address_type);
 208         add_term_address_addr (doc, address, "email");
 209     }
 210 }
 211
 212 static const char *
 213 skip_re_in_subject (const char *subject)
 214 {
 215     const char *s = subject;
 216
 217     while (*s) {
 218         while (*s && isspace (*s))
 219             s++;
 220         if (strncasecmp (s, "re:", 3) == 0)
 221             s += 3;
 222         else
 223             break;
 224     }
 225
 226     return s;
 227 }
 228
 229 static void
 230 find_messages_by_term (Xapian::Database db,
 231                        const char *prefix_name,
 232                        const char *value,
 233                        Xapian::PostingIterator *begin,
 234                        Xapian::PostingIterator *end)
 235 {
 236     Xapian::PostingIterator i;
 237     char *term;
 238
 239     term = g_strdup_printf ("%s%s", find_prefix (prefix_name), value);
 240
 241     *begin = db.postlist_begin (term);
 242
 243     if (end)
 244         *end = db.postlist_end (term);
 245
 246     free (term);
 247 }
 248
 249 Xapian::Document
 250 find_message_by_docid (Xapian::Database db, Xapian::docid docid)
 251 {
 252     return db.get_document (docid);
 253 }
 254
 255 Xapian::Document
 256 find_message_by_message_id (Xapian::Database db, const char *message_id)
 257 {
 258     Xapian::PostingIterator i, end;
 259
 260     find_messages_by_term (db, "msgid", message_id, &i, &end);
 261
 262     if (i != end)
 263         return find_message_by_docid (db, *i);
 264     else
 265         return Xapian::Document ();
 266 }
 267
 268 static void
 269 insert_thread_id (GHashTable *thread_ids, Xapian::Document doc)
 270 {
 271     string value_string;
 272     const char *value;
 273
 274     value_string = doc.get_value (NOTMUCH_VALUE_THREAD);
 275     value = value_string.c_str();
 276     if (strlen (value))
 277         g_hash_table_insert (thread_ids, strdup (value), NULL);
 278 }
 279
 280 /* Return one or more thread_ids, (as a GPtrArray of strings), for the
 281  * given message based on looking into the database for any messages
 282  * referenced in parents, and also for any messages in the database
 283  * referencing message_id.
 284  *
 285  * Caller should free all strings in the array and the array itself,
 286  * (g_ptr_array_free) when done. */
 287 static GPtrArray *
 288 find_thread_ids (Xapian::Database db,
 289                  GPtrArray *parents,
 290                  const char *message_id)
 291 {
 292     Xapian::PostingIterator child, children_end;
 293     Xapian::Document doc;
 294     GHashTable *thread_ids;
 295     GList *keys, *l;
 296     unsigned int i;
 297     const char *parent_message_id;
 298     GPtrArray *result;
 299
 300     thread_ids = g_hash_table_new (g_str_hash, g_str_equal);
 301
 302     find_messages_by_term (db, "ref", message_id, &child, &children_end);
 303     for ( ; child != children_end; child++) {
 304         doc = find_message_by_docid (db, *child);
 305         insert_thread_id (thread_ids, doc);
 306     }
 307
 308     for (i = 0; i < parents->len; i++) {
 309         parent_message_id = (char *) g_ptr_array_index (parents, i);
 310         doc = find_message_by_message_id (db, parent_message_id);
 311         insert_thread_id (thread_ids, doc);
 312     }
 313
 314     result = g_ptr_array_new ();
 315
 316     keys = g_hash_table_get_keys (thread_ids);
 317     for (l = keys; l; l = l->next) {
 318         char *id = (char *) l->data;
 319         g_ptr_array_add (result, id);
 320     }
 321
 322     return result;
 323 }
 324
 325 /* Add a term for each message-id in the References header of the
 326  * message. */
 327 static void
 328 parse_references (GPtrArray *array,
 329                   const char *refs_str)
 330 {
 331     GMimeReferences *refs, *r;
 332     const char *message_id;
 333
 334     if (refs_str == NULL)
 335         return;
 336
 337     refs = g_mime_references_decode (refs_str);
 338
 339     for (r = refs; r; r = r->next) {
 340         message_id = g_mime_references_get_message_id (r);
 341         g_ptr_array_add (array, g_strdup (message_id));
 342     }
 343
 344     g_mime_references_free (refs);
 345 }
 346
 347 /* Given a string representing the body of a message, generate terms
 348  * for it, (skipping quoted portions and signatures). */
 349 static void
 350 gen_terms_body_str (Xapian::TermGenerator term_gen,
 351                     char *body)
 352 {
 353     char *line, *line_end, *next_line;
 354
 355     if (body == NULL)
 356         return;
 357
 358     next_line = body;
 359
 360     while (1) {
 361         line = next_line;
 362         if (*line == '\0')
 363             break;
 364
 365         next_line = strchr (line, '\n');
 366         if (next_line == NULL) {
 367             next_line = line + strlen (line);
 368         }
 369         line_end = next_line - 1;
 370
 371         /* Trim whitespace. */
 372         while (*next_line && isspace (*next_line))
 373             next_line++;
 374
 375         /* Skip lines that are quotes. */
 376         if (*line == '>')
 377             continue;
 378
 379         /* Also skip lines introducing a quote on the next line. */
 380         if (*line_end == ':' && *next_line == '>')
 381             continue;
 382
 383         /* Finally, bail as soon as we see a signature. */
 384         /* XXX: Should only do this if "near" the end of the message. */
 385         if (strncmp (line, "-- ", 3) == 0 ||
 386             strncmp (line, "----------", 10) == 0 ||
 387             strncmp (line, "__________", 10) == 0)
 388             break;
 389
 390         *(line_end + 1) = '\0';
 391         gen_terms (term_gen, "body", line);
 392     }
 393 }
 394
 395
 396 /* Callback to generate terms for each mime part of a message. */
 397 static void
 398 gen_terms_part (Xapian::TermGenerator term_gen,
 399                 GMimeObject *part)
 400 {
 401     GMimeStream *stream;
 402     GMimeDataWrapper *wrapper;
 403     GByteArray *byte_array;
 404     char *body;
 405
 406     if (GMIME_IS_MULTIPART (part)) {
 407         GMimeMultipart *multipart = GMIME_MULTIPART (part);
 408         int i;
 409
 410         for (i = 0; i < g_mime_multipart_get_count (multipart); i++) {
 411             if (GMIME_IS_MULTIPART_SIGNED (multipart)) {
 412                 /* Don't index the signature. */
 413                 if (i == 1)
 414                     continue;
 415                 if (i > 1)
 416                     fprintf (stderr, "Warning: Unexpected extra parts of mutlipart/signed. Indexing anyway.\n");
 417             }
 418             gen_terms_part (term_gen,
 419                             g_mime_multipart_get_part (multipart, i));
 420         }
 421         return;
 422     }
 423
 424     if (! GMIME_IS_PART (part)) {
 425         fprintf (stderr, "Warning: Not indexing unknown mime part: %s.\n",
 426                  g_type_name (G_OBJECT_TYPE (part)));
 427         return;
 428     }
 429
 430     byte_array = g_byte_array_new ();
 431
 432     stream = g_mime_stream_mem_new_with_byte_array (byte_array);
 433     g_mime_stream_mem_set_owner (GMIME_STREAM_MEM (stream), FALSE);
 434     wrapper = g_mime_part_get_content_object (GMIME_PART (part));
 435     g_mime_data_wrapper_write_to_stream (wrapper, stream);
 436
 437     g_object_unref (stream);
 438
 439     body = (char *) g_byte_array_free (byte_array, FALSE);
 440
 441     gen_terms_body_str (term_gen, body);
 442
 443     free (body);
 444 }
 445
 446 static void
 447 index_file (Xapian::WritableDatabase db,
 448             Xapian::TermGenerator term_gen,
 449             const char *filename)
 450 {
 451     Xapian::Document doc;
 452
 453     GMimeStream *stream;
 454     GMimeParser *parser;
 455     GMimeMessage *message;
 456     InternetAddressList *addresses;
 457     GPtrArray *parents, *thread_ids;
 458
 459     FILE *file;
 460
 461     const char *subject, *refs, *in_reply_to, *from;
 462     const char *message_id;
 463
 464     time_t time;
 465     struct tm gm_time_tm;
 466     char date_str[16]; /* YYYYMMDDHHMMSS + 1 for Y100k compatibility ;-) */
 467     unsigned int i;
 468
 469     file = fopen (filename, "r");
 470     if (! file) {
 471         fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
 472         exit (1);
 473     }
 474
 475     stream = g_mime_stream_file_new (file);
 476
 477     parser = g_mime_parser_new_with_stream (stream);
 478
 479     message = g_mime_parser_construct_message (parser);
 480
 481     doc = Xapian::Document ();
 482
 483     doc.set_data (filename);
 484
 485     term_gen.set_stemmer (Xapian::Stem ("english"));
 486
 487     term_gen.set_document (doc);
 488
 489     from = g_mime_message_get_sender (message);
 490     addresses = internet_address_list_parse_string (from);
 491
 492     gen_terms_address_names (term_gen, addresses, "from_name");
 493
 494     addresses = g_mime_message_get_all_recipients (message);
 495     gen_terms_address_names (term_gen, addresses, "to_name");
 496
 497     subject = g_mime_message_get_subject (message);
 498     subject = skip_re_in_subject (subject);
 499     gen_terms (term_gen, "subject", subject);
 500     gen_terms (term_gen, "body", subject);
 501
 502     gen_terms_part (term_gen, g_mime_message_get_mime_part (message));
 503
 504     parents = g_ptr_array_new ();
 505
 506     refs = g_mime_object_get_header (GMIME_OBJECT (message), "references");
 507     parse_references (parents, refs);
 508
 509     in_reply_to = g_mime_object_get_header (GMIME_OBJECT (message),
 510                                             "in-reply-to");
 511     parse_references (parents, in_reply_to);
 512
 513     for (i = 0; i < parents->len; i++)
 514         add_term (doc, "ref", (char *) g_ptr_array_index (parents, i));
 515
 516     message_id = g_mime_message_get_message_id (message);
 517
 518     thread_ids = find_thread_ids (db, parents, message_id);
 519
 520     for (i = 0; i < parents->len; i++)
 521         g_free (g_ptr_array_index (parents, i));
 522     g_ptr_array_free (parents, TRUE);
 523
 524     from = g_mime_message_get_sender (message);
 525     addresses = internet_address_list_parse_string (from);
 526
 527     add_terms_address_addrs (doc, addresses, "from_email");
 528
 529     add_terms_address_addrs (doc,
 530                              g_mime_message_get_all_recipients (message),
 531                              "to_email");
 532
 533     g_mime_message_get_date (message, &time, NULL);
 534
 535     gmtime_r (&time, &gm_time_tm);
 536
 537     if (strftime (date_str, sizeof (date_str),
 538                   "%Y%m%d%H%M%S", &gm_time_tm) == 0) {
 539         fprintf (stderr, "Internal error formatting time\n");
 540         exit (1);
 541     }
 542
 543     add_term (doc, "date", date_str);
 544
 545     add_term (doc, "label", "inbox");
 546     add_term (doc, "label", "unread");
 547     add_term (doc, "type", "mail");
 548     add_term (doc, "source_id", "1");
 549
 550     add_term (doc, "msgid", message_id);
 551     doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
 552
 553     if (thread_ids->len) {
 554         unsigned int i;
 555         GString *thread_id;
 556         char *id;
 557
 558         for (i = 0; i < thread_ids->len; i++) {
 559             id = (char *) thread_ids->pdata[i];
 560
 561             add_term (doc, "thread", id);
 562
 563             if (i == 0)
 564                 thread_id = g_string_new (id);
 565             else
 566                 g_string_append_printf (thread_id, ",%s", id);
 567
 568             free (id);
 569         }
 570         g_ptr_array_free (thread_ids, TRUE);
 571
 572         doc.add_value (NOTMUCH_VALUE_THREAD, thread_id->str);
 573
 574         g_string_free (thread_id, TRUE);
 575     } else {
 576         /* If not referenced thread, use the message ID */
 577         add_term (doc, "thread", message_id);
 578         doc.add_value (NOTMUCH_VALUE_THREAD, message_id);
 579     }
 580
 581     doc.add_value (NOTMUCH_VALUE_DATE, Xapian::sortable_serialise (time));
 582
 583     db.add_document (doc);
 584
 585     g_object_unref (message);
 586     g_object_unref (parser);
 587     g_object_unref (stream);
 588 }
 589
 590 static void
 591 usage (const char *argv0)
 592 {
 593     fprintf (stderr, "Usage: %s <path-to-xapian-database>\n", argv0);
 594     fprintf (stderr, "\n");
 595     fprintf (stderr, "Messages to be indexed are read from stdnin as absolute filenames\n");
 596     fprintf (stderr, "one file per line.");
 597 }
 598
 599 int
 600 main (int argc, char **argv)
 601 {
 602     const char *database_path;
 603     char *filename;
 604     GIOChannel *channel;
 605     GIOStatus gio_status;
 606     GError *error = NULL;
 607
 608     if (argc < 2) {
 609         usage (argv[0]);
 610         exit (1);
 611     }
 612
 613     database_path = argv[1];
 614
 615     g_mime_init (0);
 616
 617     try {
 618         Xapian::WritableDatabase db;
 619         Xapian::TermGenerator term_gen;
 620
 621         db = Xapian::WritableDatabase (database_path,
 622                                        Xapian::DB_CREATE_OR_OPEN);
 623
 624         term_gen = Xapian::TermGenerator ();
 625
 626         channel = g_io_channel_unix_new (fileno (stdin));
 627
 628         while (1) {
 629             gio_status = g_io_channel_read_line (channel, &filename,
 630                                                  NULL, NULL, &error);
 631             if (gio_status == G_IO_STATUS_EOF)
 632                 break;
 633             if (gio_status != G_IO_STATUS_NORMAL) {
 634                 fprintf (stderr, "An error occurred reading from stdin: %s\n",
 635                          error->message);
 636                 exit (1);
 637             }
 638
 639             g_strchomp (filename);
 640             index_file (db, term_gen, filename);
 641
 642             g_free (filename);
 643         }
 644
 645     } catch (const Xapian::Error &error) {
 646         cerr << "A Xapian exception occurred: " << error.get_msg () << endl;
 647         exit (1);
 648     }
 649
 650     return 0;
 651 }