git.notmuchmail.org Git - notmuch/blob - lib/message-file.c

   1 /* message.c - Utility functions for parsing an email message for notmuch.
   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 https://www.gnu.org/licenses/ .
  17  *
  18  * Author: Carl Worth <cworth@cworth.org>
  19  */
  20
  21 #include <stdarg.h>
  22
  23 #include "notmuch-private.h"
  24
  25 #include <gmime/gmime.h>
  26
  27 #include <glib.h> /* GHashTable */
  28
  29 struct _notmuch_message_file {
  30     /* open stream to (possibly gzipped) file */
  31     GMimeStream *stream;
  32     char *filename;
  33
  34     /* Cache for decoded headers */
  35     GHashTable *headers;
  36
  37     GMimeMessage *message;
  38 };
  39
  40 static int
  41 _notmuch_message_file_destructor (notmuch_message_file_t *message)
  42 {
  43     if (message->headers)
  44         g_hash_table_destroy (message->headers);
  45
  46     if (message->message)
  47         g_object_unref (message->message);
  48
  49     if (message->stream)
  50         g_object_unref (message->stream);
  51
  52     return 0;
  53 }
  54
  55 /* Create a new notmuch_message_file_t for 'filename' with 'ctx' as
  56  * the talloc owner. */
  57 notmuch_message_file_t *
  58 _notmuch_message_file_open_ctx (notmuch_database_t *notmuch,
  59                                 void *ctx, const char *filename)
  60 {
  61     notmuch_message_file_t *message;
  62
  63     message = talloc_zero (ctx, notmuch_message_file_t);
  64     if (unlikely (message == NULL))
  65         return NULL;
  66
  67     const char *prefix = notmuch_config_get (notmuch, NOTMUCH_CONFIG_MAIL_ROOT);
  68
  69     if (prefix == NULL)
  70         goto FAIL;
  71
  72     if (*filename == '/') {
  73         if (strncmp (filename, prefix, strlen (prefix)) != 0) {
  74             _notmuch_database_log (notmuch, "Error opening %s: path outside mail root\n",
  75                                    filename);
  76             errno = 0;
  77             goto FAIL;
  78         }
  79         message->filename = talloc_strdup (message, filename);
  80     } else {
  81         message->filename = talloc_asprintf (message, "%s/%s", prefix, filename);
  82     }
  83
  84     if (message->filename == NULL)
  85         goto FAIL;
  86
  87     talloc_set_destructor (message, _notmuch_message_file_destructor);
  88
  89     message->stream = g_mime_stream_gzfile_open (message->filename);
  90     if (message->stream == NULL)
  91         goto FAIL;
  92
  93     return message;
  94
  95   FAIL:
  96     if (errno)
  97         _notmuch_database_log (notmuch, "Error opening %s: %s\n",
  98                                filename, strerror (errno));
  99     _notmuch_message_file_close (message);
 100
 101     return NULL;
 102 }
 103
 104 notmuch_message_file_t *
 105 _notmuch_message_file_open (notmuch_database_t *notmuch,
 106                             const char *filename)
 107 {
 108     return _notmuch_message_file_open_ctx (notmuch, NULL, filename);
 109 }
 110
 111 const char *
 112 _notmuch_message_file_get_filename (notmuch_message_file_t *message_file)
 113 {
 114     return message_file->filename;
 115 }
 116
 117 void
 118 _notmuch_message_file_close (notmuch_message_file_t *message)
 119 {
 120     talloc_free (message);
 121 }
 122
 123 static bool
 124 _is_mbox (GMimeStream *stream)
 125 {
 126     char from_buf[5];
 127     bool ret = false;
 128
 129     /* Is this mbox? */
 130     if (g_mime_stream_read (stream, from_buf, sizeof (from_buf)) == sizeof (from_buf) &&
 131         strncmp (from_buf, "From ", 5) == 0)
 132         ret = true;
 133
 134     g_mime_stream_reset (stream);
 135
 136     return ret;
 137 }
 138
 139 notmuch_status_t
 140 _notmuch_message_file_parse (notmuch_message_file_t *message)
 141 {
 142     GMimeParser *parser;
 143     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
 144     static int initialized = 0;
 145     bool is_mbox;
 146
 147     if (message->message)
 148         return NOTMUCH_STATUS_SUCCESS;
 149
 150     is_mbox = _is_mbox (message->stream);
 151
 152     if (! initialized) {
 153         g_mime_init ();
 154         initialized = 1;
 155     }
 156
 157     message->headers = g_hash_table_new_full (strcase_hash, strcase_equal,
 158                                               free, g_free);
 159     if (! message->headers)
 160         return NOTMUCH_STATUS_OUT_OF_MEMORY;
 161
 162     parser = g_mime_parser_new_with_stream (message->stream);
 163     g_mime_parser_set_scan_from (parser, is_mbox);
 164
 165     message->message = g_mime_parser_construct_message (parser, NULL);
 166     if (! message->message) {
 167         status = NOTMUCH_STATUS_FILE_NOT_EMAIL;
 168         goto DONE;
 169     }
 170
 171     if (is_mbox && ! g_mime_parser_eos (parser)) {
 172         /*
 173          * This is a multi-message mbox. (For historical reasons, we
 174          * do support single-message mboxes.)
 175          */
 176         status = NOTMUCH_STATUS_FILE_NOT_EMAIL;
 177     }
 178
 179   DONE:
 180     g_mime_stream_reset (message->stream);
 181     g_object_unref (parser);
 182
 183     if (status) {
 184         g_hash_table_destroy (message->headers);
 185         message->headers = NULL;
 186
 187         if (message->message) {
 188             g_object_unref (message->message);
 189             message->message = NULL;
 190         }
 191
 192     }
 193
 194     return status;
 195 }
 196
 197 notmuch_status_t
 198 _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
 199                                         GMimeMessage **mime_message)
 200 {
 201     notmuch_status_t status;
 202
 203     status = _notmuch_message_file_parse (message);
 204     if (status)
 205         return status;
 206
 207     *mime_message = message->message;
 208
 209     return NOTMUCH_STATUS_SUCCESS;
 210 }
 211
 212 /*
 213  * Get all instances of a header decoded and concatenated.
 214  *
 215  * The result must be freed using g_free().
 216  *
 217  * Return NULL on errors, empty string for non-existing headers.
 218  */
 219
 220 static char *
 221 _extend_header (char *combined, const char *value)
 222 {
 223     char *decoded;
 224
 225     decoded = g_mime_utils_header_decode_text (NULL, value);
 226     if (! decoded) {
 227         if (combined) {
 228             g_free (combined);
 229             combined = NULL;
 230         }
 231         goto DONE;
 232     }
 233
 234     if (combined) {
 235         char *tmp = g_strdup_printf ("%s %s", combined, decoded);
 236         g_free (decoded);
 237         g_free (combined);
 238         if (! tmp) {
 239             combined = NULL;
 240             goto DONE;
 241         }
 242
 243         combined = tmp;
 244     } else {
 245         combined = decoded;
 246     }
 247   DONE:
 248     return combined;
 249 }
 250
 251 static char *
 252 _notmuch_message_file_get_combined_header (notmuch_message_file_t *message,
 253                                            const char *header)
 254 {
 255     char *combined = NULL;
 256     GMimeHeaderList *headers;
 257
 258     headers = g_mime_object_get_header_list (GMIME_OBJECT (message->message));
 259     if (! headers)
 260         return NULL;
 261
 262
 263     for (int i = 0; i < g_mime_header_list_get_count (headers); i++) {
 264         const char *value;
 265         GMimeHeader *g_header = g_mime_header_list_get_header_at (headers, i);
 266
 267         if (strcasecmp (g_mime_header_get_name (g_header), header) != 0)
 268             continue;
 269
 270         /* GMime retains ownership of value, we hope */
 271         value = g_mime_header_get_value (g_header);
 272
 273         combined = _extend_header (combined, value);
 274     }
 275
 276     /* Return empty string for non-existing headers. */
 277     if (! combined)
 278         combined = g_strdup ("");
 279
 280     return combined;
 281 }
 282
 283 const char *
 284 _notmuch_message_file_get_header (notmuch_message_file_t *message,
 285                                   const char *header)
 286 {
 287     const char *value;
 288     char *decoded;
 289
 290     if (_notmuch_message_file_parse (message))
 291         return NULL;
 292
 293     /* If we have a cached decoded value, use it. */
 294     value = g_hash_table_lookup (message->headers, header);
 295     if (value)
 296         return value;
 297
 298     if (strcasecmp (header, "received") == 0) {
 299         /*
 300          * The Received: header is special. We concatenate all
 301          * instances of the header as we use this when analyzing the
 302          * path the mail has taken from sender to recipient.
 303          */
 304         decoded = _notmuch_message_file_get_combined_header (message, header);
 305     } else {
 306         value = g_mime_object_get_header (GMIME_OBJECT (message->message),
 307                                           header);
 308         if (value)
 309             decoded = g_mime_utils_header_decode_text (NULL, value);
 310         else
 311             decoded = g_strdup ("");
 312     }
 313
 314     if (! decoded)
 315         return NULL;
 316
 317     /* Cache the decoded value. We also own the strings. */
 318     g_hash_table_insert (message->headers, xstrdup (header), decoded);
 319
 320     return decoded;
 321 }
 322
 323 notmuch_status_t
 324 _notmuch_message_file_get_headers (notmuch_message_file_t *message_file,
 325                                    const char **from_out,
 326                                    const char **subject_out,
 327                                    const char **to_out,
 328                                    const char **date_out,
 329                                    char **message_id_out)
 330 {
 331     notmuch_status_t ret;
 332     const char *header;
 333     const char *from, *to, *subject, *date;
 334     char *message_id = NULL;
 335
 336     /* Parse message up front to get better error status. */
 337     ret = _notmuch_message_file_parse (message_file);
 338     if (ret)
 339         goto DONE;
 340
 341     /* Before we do any real work, (especially before doing a
 342      * potential SHA-1 computation on the entire file's contents),
 343      * let's make sure that what we're looking at looks like an
 344      * actual email message.
 345      */
 346     from = _notmuch_message_file_get_header (message_file, "from");
 347     subject = _notmuch_message_file_get_header (message_file, "subject");
 348     to = _notmuch_message_file_get_header (message_file, "to");
 349     date = _notmuch_message_file_get_header (message_file, "date");
 350
 351     if ((from == NULL || *from == '\0') &&
 352         (subject == NULL || *subject == '\0') &&
 353         (to == NULL || *to == '\0')) {
 354         ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
 355         goto DONE;
 356     }
 357
 358     /* Now that we're sure it's mail, the first order of business
 359      * is to find a message ID (or else create one ourselves).
 360      */
 361     header = _notmuch_message_file_get_header (message_file, "message-id");
 362     if (header && *header != '\0') {
 363         message_id = _notmuch_message_id_parse (message_file, header, NULL);
 364
 365         /* So the header value isn't RFC-compliant, but it's
 366          * better than no message-id at all.
 367          */
 368         if (message_id == NULL)
 369             message_id = talloc_strdup (message_file, header);
 370     }
 371
 372     if (message_id == NULL ) {
 373         /* No message-id at all, let's generate one by taking a
 374          * hash over the file's contents.
 375          */
 376         char *sha1 = _notmuch_sha1_of_file (_notmuch_message_file_get_filename (message_file));
 377
 378         /* If that failed too, something is really wrong. Give up. */
 379         if (sha1 == NULL) {
 380             ret = NOTMUCH_STATUS_FILE_ERROR;
 381             goto DONE;
 382         }
 383
 384         message_id = talloc_asprintf (message_file, "notmuch-sha1-%s", sha1);
 385         free (sha1);
 386     }
 387   DONE:
 388     if (ret == NOTMUCH_STATUS_SUCCESS) {
 389         if (from_out)
 390             *from_out = from;
 391         if (subject_out)
 392             *subject_out = subject;
 393         if (to_out)
 394             *to_out = to;
 395         if (date_out)
 396             *date_out = date;
 397         if (message_id_out)
 398             *message_id_out = message_id;
 399     }
 400     return ret;
 401 }