git.notmuchmail.org Git - notmuch/blob - lib/index.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 https://www.gnu.org/licenses/ .
  16  *
  17  * Author: Carl Worth <cworth@cworth.org>
  18  */
  19
  20 #include "notmuch-private.h"
  21
  22 #include <gmime/gmime.h>
  23 #include <gmime/gmime-filter.h>
  24
  25 #include <xapian.h>
  26
  27
  28 typedef struct {
  29     int state;
  30     int a;
  31     int b;
  32     int next_if_match;
  33     int next_if_not_match;
  34 } scanner_state_t;
  35
  36 /* Simple, linear state-transition diagram for the uuencode filter.
  37  *
  38  * If the character being processed is within the range of [a, b]
  39  * for the current state then we transition next_if_match
  40  * state. If not, we transition to the next_if_not_match state.
  41  *
  42  * The final two states are special in that they are the states in
  43  * which we discard data. */
  44 static const int first_uuencode_skipping_state = 11;
  45 static const scanner_state_t uuencode_states[] = {
  46     {0,  'b',  'b',  1,  0},
  47     {1,  'e',  'e',  2,  0},
  48     {2,  'g',  'g',  3,  0},
  49     {3,  'i',  'i',  4,  0},
  50     {4,  'n',  'n',  5,  0},
  51     {5,  ' ',  ' ',  6,  0},
  52     {6,  '0',  '7',  7,  0},
  53     {7,  '0',  '7',  8,  0},
  54     {8,  '0',  '7',  9,  0},
  55     {9,  ' ',  ' ',  10, 0},
  56     {10, '\n', '\n', 11, 10},
  57     {11, 'M',  'M',  12, 0},
  58     {12, ' ',  '`',  12, 11}
  59 };
  60
  61 /* The following table is intended to implement this DFA (in 'dot'
  62    format). Note that 2 and 3 are "hidden" states used to step through
  63    the possible out edges of state 1.
  64
  65 digraph html_filter {
  66        0 -> 1  [label="<"];
  67        0 -> 0;
  68        1 -> 4 [label="'"];
  69        1 -> 5 [label="\""];
  70        1 -> 0 [label=">"];
  71        1 -> 1;
  72        4 -> 1 [label="'"];
  73        4 -> 4;
  74        5 -> 1 [label="\""];
  75        5 -> 5;
  76 }
  77 */
  78 static const int first_html_skipping_state = 1;
  79 static const scanner_state_t html_states[] = {
  80     {0,  '<',  '<',  1,  0},
  81     {1,  '\'', '\'', 4,  2},  /* scanning for quote or > */
  82     {1,  '"',  '"',  5,  3},
  83     {1,  '>',  '>',  0,  1},
  84     {4,  '\'', '\'', 1,  4},  /* inside single quotes */
  85     {5,  '"', '"',   1,  5},  /* inside double quotes */
  86 };
  87
  88 /* Oh, how I wish that gobject didn't require so much noisy boilerplate!
  89  * (Though I have at least eliminated some of the stock set...) */
  90 typedef struct _NotmuchFilterDiscardNonTerm NotmuchFilterDiscardNonTerm;
  91 typedef struct _NotmuchFilterDiscardNonTermClass NotmuchFilterDiscardNonTermClass;
  92
  93 /**
  94  * NotmuchFilterDiscardNonTerm:
  95  *
  96  * @parent_object: parent #GMimeFilter
  97  * @encode: encoding vs decoding
  98  * @state: State of the parser
  99  *
 100  * A filter to discard uuencoded portions of an email.
 101  *
 102  * A uuencoded portion is identified as beginning with a line
 103  * matching:
 104  *
 105  *      begin [0-7][0-7][0-7] .*
 106  *
 107  * After that detection, and beginning with the following line,
 108  * characters will be discarded as long as the first character of each
 109  * line begins with M and subsequent characters on the line are within
 110  * the range of ASCII characters from ' ' to '`'.
 111  *
 112  * This is not a perfect UUencode filter. It's possible to have a
 113  * message that will legitimately match that pattern, (so that some
 114  * legitimate content is discarded). And for most UUencoded files, the
 115  * final line of encoded data (the line not starting with M) will be
 116  * indexed.
 117  **/
 118 struct _NotmuchFilterDiscardNonTerm {
 119     GMimeFilter parent_object;
 120     GMimeContentType *content_type;
 121     int state;
 122     int first_skipping_state;
 123     const scanner_state_t *states;
 124 };
 125
 126 struct _NotmuchFilterDiscardNonTermClass {
 127     GMimeFilterClass parent_class;
 128 };
 129
 130 static GMimeFilter *notmuch_filter_discard_non_term_new (GMimeContentType *content);
 131
 132 static void notmuch_filter_discard_non_term_finalize (GObject *object);
 133
 134 static GMimeFilter *filter_copy (GMimeFilter *filter);
 135 static void filter_filter (GMimeFilter *filter, char *in, size_t len, size_t prespace,
 136                            char **out, size_t *outlen, size_t *outprespace);
 137 static void filter_complete (GMimeFilter *filter, char *in, size_t len, size_t prespace,
 138                              char **out, size_t *outlen, size_t *outprespace);
 139 static void filter_reset (GMimeFilter *filter);
 140
 141
 142 static GMimeFilterClass *parent_class = NULL;
 143
 144 static void
 145 notmuch_filter_discard_non_term_class_init (NotmuchFilterDiscardNonTermClass *klass,
 146                                             unused (void *class_data))
 147 {
 148     GObjectClass *object_class = G_OBJECT_CLASS (klass);
 149     GMimeFilterClass *filter_class = GMIME_FILTER_CLASS (klass);
 150
 151     parent_class = (GMimeFilterClass *) g_type_class_ref (GMIME_TYPE_FILTER);
 152
 153     object_class->finalize = notmuch_filter_discard_non_term_finalize;
 154
 155     filter_class->copy = filter_copy;
 156     filter_class->filter = filter_filter;
 157     filter_class->complete = filter_complete;
 158     filter_class->reset = filter_reset;
 159 }
 160
 161 static void
 162 notmuch_filter_discard_non_term_finalize (GObject *object)
 163 {
 164     G_OBJECT_CLASS (parent_class)->finalize (object);
 165 }
 166
 167 static GMimeFilter *
 168 filter_copy (GMimeFilter *gmime_filter)
 169 {
 170     NotmuchFilterDiscardNonTerm *filter = (NotmuchFilterDiscardNonTerm *) gmime_filter;
 171     return notmuch_filter_discard_non_term_new (filter->content_type);
 172 }
 173
 174 static void
 175 filter_filter (GMimeFilter *gmime_filter, char *inbuf, size_t inlen, size_t prespace,
 176                char **outbuf, size_t *outlen, size_t *outprespace)
 177 {
 178     NotmuchFilterDiscardNonTerm *filter = (NotmuchFilterDiscardNonTerm *) gmime_filter;
 179     const scanner_state_t *states = filter->states;
 180     const char *inptr = inbuf;
 181     const char *inend = inbuf + inlen;
 182     char *outptr;
 183
 184     (void) prespace;
 185
 186     int next;
 187
 188     g_mime_filter_set_size (gmime_filter, inlen, false);
 189     outptr = gmime_filter->outbuf;
 190
 191     next = filter->state;
 192     while (inptr < inend) {
 193          /* Each state is defined by a contiguous set of rows of the
 194          * state table marked by a common value for '.state'. The
 195          * state numbers must be equal to the index of the first row
 196          * in a given state; thus the loop condition here looks for a
 197          * jump to a first row of a state, which is a real transition
 198          * in the underlying DFA.
 199          */
 200         do {
 201             if (*inptr >= states[next].a && *inptr <= states[next].b)  {
 202                 next = states[next].next_if_match;
 203             } else  {
 204                 next = states[next].next_if_not_match;
 205             }
 206
 207         } while (next != states[next].state);
 208
 209         if (filter->state < filter->first_skipping_state)
 210             *outptr++ = *inptr;
 211
 212         filter->state = next;
 213         inptr++;
 214     }
 215
 216     *outlen = outptr - gmime_filter->outbuf;
 217     *outprespace = gmime_filter->outpre;
 218     *outbuf = gmime_filter->outbuf;
 219 }
 220
 221 static void
 222 filter_complete (GMimeFilter *filter, char *inbuf, size_t inlen, size_t prespace,
 223                  char **outbuf, size_t *outlen, size_t *outprespace)
 224 {
 225     if (inbuf && inlen)
 226         filter_filter (filter, inbuf, inlen, prespace, outbuf, outlen, outprespace);
 227 }
 228
 229 static void
 230 filter_reset (GMimeFilter *gmime_filter)
 231 {
 232     NotmuchFilterDiscardNonTerm *filter = (NotmuchFilterDiscardNonTerm *) gmime_filter;
 233
 234     filter->state = 0;
 235 }
 236
 237 /**
 238  * notmuch_filter_discard_non_term_new:
 239  *
 240  * Returns: a new #NotmuchFilterDiscardNonTerm filter.
 241  **/
 242 static GMimeFilter *
 243 notmuch_filter_discard_non_term_new (GMimeContentType *content_type)
 244 {
 245     static GType type = 0;
 246     NotmuchFilterDiscardNonTerm *filter;
 247
 248     if (!type) {
 249         static const GTypeInfo info = {
 250             .class_size = sizeof (NotmuchFilterDiscardNonTermClass),
 251             .base_init = NULL,
 252             .base_finalize = NULL,
 253             .class_init = (GClassInitFunc) notmuch_filter_discard_non_term_class_init,
 254             .class_finalize = NULL,
 255             .class_data = NULL,
 256             .instance_size = sizeof (NotmuchFilterDiscardNonTerm),
 257             .n_preallocs = 0,
 258             .instance_init = NULL,
 259             .value_table = NULL,
 260         };
 261
 262         type = g_type_register_static (GMIME_TYPE_FILTER, "NotmuchFilterDiscardNonTerm", &info, (GTypeFlags) 0);
 263     }
 264
 265     filter = (NotmuchFilterDiscardNonTerm *) g_object_new (type, NULL);
 266     filter->content_type = content_type;
 267     filter->state = 0;
 268     if (g_mime_content_type_is_type (content_type, "text", "html")) {
 269       filter->states = html_states;
 270       filter->first_skipping_state = first_html_skipping_state;
 271     } else {
 272       filter->states = uuencode_states;
 273       filter->first_skipping_state = first_uuencode_skipping_state;
 274     }
 275
 276     return (GMimeFilter *) filter;
 277 }
 278
 279 /* We're finally down to a single (NAME + address) email "mailbox". */
 280 static void
 281 _index_address_mailbox (notmuch_message_t *message,
 282                         const char *prefix_name,
 283                         InternetAddress *address)
 284 {
 285     InternetAddressMailbox *mailbox = INTERNET_ADDRESS_MAILBOX (address);
 286     const char *name, *addr, *combined;
 287     void *local = talloc_new (message);
 288
 289     name = internet_address_get_name (address);
 290     addr = internet_address_mailbox_get_addr (mailbox);
 291
 292     /* Combine the name and address and index them as a phrase. */
 293     if (name && addr)
 294         combined = talloc_asprintf (local, "%s %s", name, addr);
 295     else if (name)
 296         combined = name;
 297     else
 298         combined = addr;
 299
 300     if (combined)
 301         _notmuch_message_gen_terms (message, prefix_name, combined);
 302
 303     talloc_free (local);
 304 }
 305
 306 static void
 307 _index_address_list (notmuch_message_t *message,
 308                      const char *prefix_name,
 309                      InternetAddressList *addresses);
 310
 311 /* The outer loop over the InternetAddressList wasn't quite enough.
 312  * There can actually be a tree here where a single member of the list
 313  * is a "group" containing another list. Recurse please.
 314  */
 315 static void
 316 _index_address_group (notmuch_message_t *message,
 317                       const char *prefix_name,
 318                       InternetAddress *address)
 319 {
 320     InternetAddressGroup *group;
 321     InternetAddressList *list;
 322
 323     group = INTERNET_ADDRESS_GROUP (address);
 324     list = internet_address_group_get_members (group);
 325
 326     if (! list)
 327         return;
 328
 329     _index_address_list (message, prefix_name, list);
 330 }
 331
 332 static void
 333 _index_address_list (notmuch_message_t *message,
 334                      const char *prefix_name,
 335                      InternetAddressList *addresses)
 336 {
 337     int i;
 338     InternetAddress *address;
 339
 340     if (addresses == NULL)
 341         return;
 342
 343     for (i = 0; i < internet_address_list_length (addresses); i++) {
 344         address = internet_address_list_get_address (addresses, i);
 345         if (INTERNET_ADDRESS_IS_MAILBOX (address)) {
 346             _index_address_mailbox (message, prefix_name, address);
 347         } else if (INTERNET_ADDRESS_IS_GROUP (address)) {
 348             _index_address_group (message, prefix_name, address);
 349         } else {
 350             INTERNAL_ERROR ("GMime InternetAddress is neither a mailbox nor a group.\n");
 351         }
 352     }
 353 }
 354
 355 static void
 356 _index_content_type (notmuch_message_t *message, GMimeObject *part)
 357 {
 358     GMimeContentType *content_type = g_mime_object_get_content_type (part);
 359     if (content_type) {
 360         char *mime_string = g_mime_content_type_get_mime_type (content_type);
 361         if (mime_string) {
 362             _notmuch_message_gen_terms (message, "mimetype", mime_string);
 363             g_free (mime_string);
 364         }
 365     }
 366 }
 367
 368 static void
 369 _index_encrypted_mime_part (notmuch_message_t *message, notmuch_indexopts_t *indexopts,
 370                             GMimeMultipartEncrypted *part);
 371
 372 /* Callback to generate terms for each mime part of a message. */
 373 static void
 374 _index_mime_part (notmuch_message_t *message,
 375                   notmuch_indexopts_t *indexopts,
 376                   GMimeObject *part)
 377 {
 378     GMimeStream *stream, *filter;
 379     GMimeFilter *discard_non_term_filter;
 380     GMimeDataWrapper *wrapper;
 381     GByteArray *byte_array;
 382     GMimeContentDisposition *disposition;
 383     GMimeContentType *content_type;
 384     char *body;
 385     const char *charset;
 386
 387     if (! part) {
 388         _notmuch_database_log (notmuch_message_get_database (message),
 389                               "Warning: Not indexing empty mime part.\n");
 390         return;
 391     }
 392
 393     _index_content_type (message, part);
 394
 395     if (GMIME_IS_MULTIPART (part)) {
 396         GMimeMultipart *multipart = GMIME_MULTIPART (part);
 397         int i;
 398
 399         if (GMIME_IS_MULTIPART_SIGNED (multipart))
 400           _notmuch_message_add_term (message, "tag", "signed");
 401
 402         if (GMIME_IS_MULTIPART_ENCRYPTED (multipart))
 403           _notmuch_message_add_term (message, "tag", "encrypted");
 404
 405         for (i = 0; i < g_mime_multipart_get_count (multipart); i++) {
 406             if (GMIME_IS_MULTIPART_SIGNED (multipart)) {
 407                 /* Don't index the signature, but index its content type. */
 408                 if (i == GMIME_MULTIPART_SIGNED_SIGNATURE) {
 409                     _index_content_type (message,
 410                                          g_mime_multipart_get_part (multipart, i));
 411                     continue;
 412                 } else if (i != GMIME_MULTIPART_SIGNED_CONTENT) {
 413                     _notmuch_database_log (notmuch_message_get_database (message),
 414                                            "Warning: Unexpected extra parts of multipart/signed. Indexing anyway.\n");
 415                 }
 416             }
 417             if (GMIME_IS_MULTIPART_ENCRYPTED (multipart)) {
 418                 _index_content_type (message,
 419                                      g_mime_multipart_get_part (multipart, i));
 420                 if (i == GMIME_MULTIPART_ENCRYPTED_CONTENT) {
 421                     _index_encrypted_mime_part(message, indexopts,
 422                                                GMIME_MULTIPART_ENCRYPTED (part));
 423                 } else {
 424                     if (i != GMIME_MULTIPART_ENCRYPTED_VERSION) {
 425                         _notmuch_database_log (notmuch_message_get_database (message),
 426                                                "Warning: Unexpected extra parts of multipart/encrypted.\n");
 427                     }
 428                 }
 429                 continue;
 430             }
 431             _index_mime_part (message, indexopts,
 432                               g_mime_multipart_get_part (multipart, i));
 433         }
 434         return;
 435     }
 436
 437     if (GMIME_IS_MESSAGE_PART (part)) {
 438         GMimeMessage *mime_message;
 439
 440         mime_message = g_mime_message_part_get_message (GMIME_MESSAGE_PART (part));
 441
 442         _index_mime_part (message, indexopts, g_mime_message_get_mime_part (mime_message));
 443
 444         return;
 445     }
 446
 447     if (! (GMIME_IS_PART (part))) {
 448         _notmuch_database_log (notmuch_message_get_database (message),
 449                               "Warning: Not indexing unknown mime part: %s.\n",
 450                               g_type_name (G_OBJECT_TYPE (part)));
 451         return;
 452     }
 453
 454     disposition = g_mime_object_get_content_disposition (part);
 455     if (disposition &&
 456         strcasecmp (g_mime_content_disposition_get_disposition (disposition),
 457                     GMIME_DISPOSITION_ATTACHMENT) == 0)
 458     {
 459         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
 460
 461         _notmuch_message_add_term (message, "tag", "attachment");
 462         _notmuch_message_gen_terms (message, "attachment", filename);
 463
 464         /* XXX: Would be nice to call out to something here to parse
 465          * the attachment into text and then index that. */
 466         return;
 467     }
 468
 469     byte_array = g_byte_array_new ();
 470
 471     stream = g_mime_stream_mem_new_with_byte_array (byte_array);
 472     g_mime_stream_mem_set_owner (GMIME_STREAM_MEM (stream), false);
 473
 474     filter = g_mime_stream_filter_new (stream);
 475
 476     content_type = g_mime_object_get_content_type (part);
 477     discard_non_term_filter = notmuch_filter_discard_non_term_new (content_type);
 478
 479     g_mime_stream_filter_add (GMIME_STREAM_FILTER (filter),
 480                               discard_non_term_filter);
 481
 482     charset = g_mime_object_get_content_type_parameter (part, "charset");
 483     if (charset) {
 484         GMimeFilter *charset_filter;
 485         charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
 486         /* This result can be NULL for things like "unknown-8bit".
 487          * Don't set a NULL filter as that makes GMime print
 488          * annoying assertion-failure messages on stderr. */
 489         if (charset_filter) {
 490             g_mime_stream_filter_add (GMIME_STREAM_FILTER (filter),
 491                                       charset_filter);
 492             g_object_unref (charset_filter);
 493         }
 494     }
 495
 496     wrapper = g_mime_part_get_content (GMIME_PART (part));
 497     if (wrapper)
 498         g_mime_data_wrapper_write_to_stream (wrapper, filter);
 499
 500     g_object_unref (stream);
 501     g_object_unref (filter);
 502     g_object_unref (discard_non_term_filter);
 503
 504     g_byte_array_append (byte_array, (guint8 *) "\0", 1);
 505     body = (char *) g_byte_array_free (byte_array, false);
 506
 507     if (body) {
 508         _notmuch_message_gen_terms (message, NULL, body);
 509
 510         free (body);
 511     }
 512 }
 513
 514 /* descend (if desired) into the cleartext part of an encrypted MIME
 515  * part while indexing. */
 516 static void
 517 _index_encrypted_mime_part (notmuch_message_t *message,
 518                             notmuch_indexopts_t *indexopts,
 519                             GMimeMultipartEncrypted *encrypted_data)
 520 {
 521     notmuch_status_t status;
 522     GError *err = NULL;
 523     notmuch_database_t * notmuch = NULL;
 524     GMimeObject *clear = NULL;
 525
 526     if (!indexopts || (notmuch_indexopts_get_decrypt_policy (indexopts) == NOTMUCH_DECRYPT_FALSE))
 527         return;
 528
 529     notmuch = notmuch_message_get_database (message);
 530
 531     bool attempted = false;
 532     GMimeDecryptResult *decrypt_result = NULL;
 533     bool get_sk = (notmuch_indexopts_get_decrypt_policy (indexopts) == NOTMUCH_DECRYPT_TRUE);
 534     clear = _notmuch_crypto_decrypt (&attempted, notmuch_indexopts_get_decrypt_policy (indexopts),
 535                                      message, encrypted_data, get_sk ? &decrypt_result : NULL, &err);
 536     if (!attempted)
 537         return;
 538     if (err || !clear) {
 539         if (decrypt_result)
 540             g_object_unref (decrypt_result);
 541         if (err) {
 542             _notmuch_database_log (notmuch, "Failed to decrypt during indexing. (%d:%d) [%s]\n",
 543                                    err->domain, err->code, err->message);
 544             g_error_free(err);
 545         } else {
 546             _notmuch_database_log (notmuch, "Failed to decrypt during indexing. (unknown error)\n");
 547         }
 548         /* Indicate that we failed to decrypt during indexing */
 549         status = notmuch_message_add_property (message, "index.decryption", "failure");
 550         if (status)
 551             _notmuch_database_log_append (notmuch, "failed to add index.decryption "
 552                                           "property (%d)\n", status);
 553         return;
 554     }
 555     if (decrypt_result) {
 556         if (get_sk) {
 557             status = notmuch_message_add_property (message, "session-key",
 558                                                    g_mime_decrypt_result_get_session_key (decrypt_result));
 559             if (status)
 560                 _notmuch_database_log (notmuch, "failed to add session-key "
 561                                        "property (%d)\n", status);
 562         }
 563         g_object_unref (decrypt_result);
 564     }
 565     _index_mime_part (message, indexopts, clear);
 566     g_object_unref (clear);
 567
 568     status = notmuch_message_add_property (message, "index.decryption", "success");
 569     if (status)
 570         _notmuch_database_log (notmuch, "failed to add index.decryption "
 571                                "property (%d)\n", status);
 572
 573 }
 574
 575 notmuch_status_t
 576 _notmuch_message_index_file (notmuch_message_t *message,
 577                              notmuch_indexopts_t *indexopts,
 578                              notmuch_message_file_t *message_file)
 579 {
 580     GMimeMessage *mime_message;
 581     InternetAddressList *addresses;
 582     const char *subject;
 583     notmuch_status_t status;
 584
 585     status = _notmuch_message_file_get_mime_message (message_file,
 586                                                      &mime_message);
 587     if (status)
 588         return status;
 589
 590     addresses = g_mime_message_get_from (mime_message);
 591     if (addresses) {
 592         _index_address_list (message, "from", addresses);
 593     }
 594
 595     addresses = g_mime_message_get_all_recipients (mime_message);
 596     if (addresses) {
 597         _index_address_list (message, "to", addresses);
 598         g_object_unref (addresses);
 599     }
 600
 601     subject = g_mime_message_get_subject (mime_message);
 602     _notmuch_message_gen_terms (message, "subject", subject);
 603
 604     _index_mime_part (message, indexopts, g_mime_message_get_mime_part (mime_message));
 605
 606     return NOTMUCH_STATUS_SUCCESS;
 607 }