git.notmuchmail.org Git - notmuch/blob - mime-node.c

   1 /* notmuch - Not much of an email program, (just index and search)
   2  *
   3  * Copyright © 2009 Carl Worth
   4  * Copyright © 2009 Keith Packard
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see http://www.gnu.org/licenses/ .
  18  *
  19  * Authors: Carl Worth <cworth@cworth.org>
  20  *          Keith Packard <keithp@keithp.com>
  21  *          Austin Clements <aclements@csail.mit.edu>
  22  */
  23
  24 #include "notmuch-client.h"
  25
  26 /* Context that gets inherited from the root node. */
  27 typedef struct mime_node_context {
  28     /* Per-message resources.  These are allocated internally and must
  29      * be destroyed. */
  30     FILE *file;
  31     GMimeStream *stream;
  32     GMimeParser *parser;
  33     GMimeMessage *mime_message;
  34
  35     /* Context provided by the caller. */
  36     notmuch_crypto_t *crypto;
  37 } mime_node_context_t;
  38
  39 static int
  40 _mime_node_context_free (mime_node_context_t *res)
  41 {
  42     if (res->mime_message)
  43         g_object_unref (res->mime_message);
  44
  45     if (res->parser)
  46         g_object_unref (res->parser);
  47
  48     if (res->stream)
  49         g_object_unref (res->stream);
  50
  51     if (res->file)
  52         fclose (res->file);
  53
  54     return 0;
  55 }
  56
  57 notmuch_status_t
  58 mime_node_open (const void *ctx, notmuch_message_t *message,
  59                 notmuch_crypto_t *crypto, mime_node_t **root_out)
  60 {
  61     const char *filename = notmuch_message_get_filename (message);
  62     mime_node_context_t *mctx;
  63     mime_node_t *root;
  64     notmuch_status_t status;
  65
  66     root = talloc_zero (ctx, mime_node_t);
  67     if (root == NULL) {
  68         fprintf (stderr, "Out of memory.\n");
  69         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
  70         goto DONE;
  71     }
  72
  73     /* Create the tree-wide context */
  74     mctx = talloc_zero (root, mime_node_context_t);
  75     if (mctx == NULL) {
  76         fprintf (stderr, "Out of memory.\n");
  77         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
  78         goto DONE;
  79     }
  80     talloc_set_destructor (mctx, _mime_node_context_free);
  81
  82     mctx->file = fopen (filename, "r");
  83     if (! mctx->file) {
  84         fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
  85         status = NOTMUCH_STATUS_FILE_ERROR;
  86         goto DONE;
  87     }
  88
  89     mctx->stream = g_mime_stream_file_new (mctx->file);
  90     if (!mctx->stream) {
  91         fprintf (stderr, "Out of memory.\n");
  92         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
  93         goto DONE;
  94     }
  95     g_mime_stream_file_set_owner (GMIME_STREAM_FILE (mctx->stream), FALSE);
  96
  97     mctx->parser = g_mime_parser_new_with_stream (mctx->stream);
  98     if (!mctx->parser) {
  99         fprintf (stderr, "Out of memory.\n");
 100         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
 101         goto DONE;
 102     }
 103
 104     mctx->mime_message = g_mime_parser_construct_message (mctx->parser);
 105     if (!mctx->mime_message) {
 106         fprintf (stderr, "Failed to parse %s\n", filename);
 107         status = NOTMUCH_STATUS_FILE_ERROR;
 108         goto DONE;
 109     }
 110
 111     mctx->crypto = crypto;
 112
 113     /* Create the root node */
 114     root->part = GMIME_OBJECT (mctx->mime_message);
 115     root->envelope_file = message;
 116     root->nchildren = 1;
 117     root->ctx = mctx;
 118
 119     root->parent = NULL;
 120     root->part_num = 0;
 121     root->next_child = 0;
 122     root->next_part_num = 1;
 123
 124     *root_out = root;
 125     return NOTMUCH_STATUS_SUCCESS;
 126
 127 DONE:
 128     talloc_free (root);
 129     return status;
 130 }
 131
 132 #ifdef GMIME_ATLEAST_26
 133 static int
 134 _signature_list_free (GMimeSignatureList **proxy)
 135 {
 136     g_object_unref (*proxy);
 137     return 0;
 138 }
 139 #else
 140 static int
 141 _signature_validity_free (GMimeSignatureValidity **proxy)
 142 {
 143     g_mime_signature_validity_free (*proxy);
 144     return 0;
 145 }
 146 #endif
 147
 148 static mime_node_t *
 149 _mime_node_create (mime_node_t *parent, GMimeObject *part)
 150 {
 151     mime_node_t *node = talloc_zero (parent, mime_node_t);
 152     GError *err = NULL;
 153     notmuch_crypto_context_t *cryptoctx = NULL;
 154
 155     /* Set basic node properties */
 156     node->part = part;
 157     node->ctx = parent->ctx;
 158     if (!talloc_reference (node, node->ctx)) {
 159         fprintf (stderr, "Out of memory.\n");
 160         talloc_free (node);
 161         return NULL;
 162     }
 163     node->parent = parent;
 164     node->part_num = node->next_part_num = -1;
 165     node->next_child = 0;
 166
 167     /* Deal with the different types of parts */
 168     if (GMIME_IS_PART (part)) {
 169         node->nchildren = 0;
 170     } else if (GMIME_IS_MULTIPART (part)) {
 171         node->nchildren = g_mime_multipart_get_count (GMIME_MULTIPART (part));
 172     } else if (GMIME_IS_MESSAGE_PART (part)) {
 173         /* Promote part to an envelope and open it */
 174         GMimeMessagePart *message_part = GMIME_MESSAGE_PART (part);
 175         GMimeMessage *message = g_mime_message_part_get_message (message_part);
 176         node->envelope_part = message_part;
 177         node->part = GMIME_OBJECT (message);
 178         node->nchildren = 1;
 179     } else {
 180         fprintf (stderr, "Warning: Unknown mime part type: %s.\n",
 181                  g_type_name (G_OBJECT_TYPE (part)));
 182         talloc_free (node);
 183         return NULL;
 184     }
 185
 186     if ((GMIME_IS_MULTIPART_ENCRYPTED (part) && node->ctx->crypto->decrypt)
 187         || (GMIME_IS_MULTIPART_SIGNED (part) && node->ctx->crypto->verify)) {
 188         GMimeContentType *content_type = g_mime_object_get_content_type (part);
 189         const char *protocol = g_mime_content_type_get_parameter (content_type, "protocol");
 190         cryptoctx = notmuch_crypto_get_context (node->ctx->crypto, protocol);
 191     }
 192
 193     /* Handle PGP/MIME parts */
 194     if (GMIME_IS_MULTIPART_ENCRYPTED (part) && node->ctx->crypto->decrypt && cryptoctx) {
 195         if (node->nchildren != 2) {
 196             /* this violates RFC 3156 section 4, so we won't bother with it. */
 197             fprintf (stderr, "Error: %d part(s) for a multipart/encrypted "
 198                      "message (must be exactly 2)\n",
 199                      node->nchildren);
 200         } else {
 201             GMimeMultipartEncrypted *encrypteddata =
 202                 GMIME_MULTIPART_ENCRYPTED (part);
 203             node->decrypt_attempted = TRUE;
 204 #ifdef GMIME_ATLEAST_26
 205             GMimeDecryptResult *decrypt_result = NULL;
 206             node->decrypted_child = g_mime_multipart_encrypted_decrypt
 207                 (encrypteddata, cryptoctx, &decrypt_result, &err);
 208 #else
 209             node->decrypted_child = g_mime_multipart_encrypted_decrypt
 210                 (encrypteddata, cryptoctx, &err);
 211 #endif
 212             if (node->decrypted_child) {
 213                 node->decrypt_success = node->verify_attempted = TRUE;
 214 #ifdef GMIME_ATLEAST_26
 215                 /* This may be NULL if the part is not signed. */
 216                 node->sig_list = g_mime_decrypt_result_get_signatures (decrypt_result);
 217                 if (node->sig_list)
 218                     g_object_ref (node->sig_list);
 219                 g_object_unref (decrypt_result);
 220 #else
 221                 node->sig_validity = g_mime_multipart_encrypted_get_signature_validity (encrypteddata);
 222 #endif
 223             } else {
 224                 fprintf (stderr, "Failed to decrypt part: %s\n",
 225                          (err ? err->message : "no error explanation given"));
 226             }
 227         }
 228     } else if (GMIME_IS_MULTIPART_SIGNED (part) && node->ctx->crypto->verify && cryptoctx) {
 229         if (node->nchildren != 2) {
 230             /* this violates RFC 3156 section 5, so we won't bother with it. */
 231             fprintf (stderr, "Error: %d part(s) for a multipart/signed message "
 232                      "(must be exactly 2)\n",
 233                      node->nchildren);
 234         } else {
 235 #ifdef GMIME_ATLEAST_26
 236             node->sig_list = g_mime_multipart_signed_verify
 237                 (GMIME_MULTIPART_SIGNED (part), cryptoctx, &err);
 238             node->verify_attempted = TRUE;
 239
 240             if (!node->sig_list)
 241                 fprintf (stderr, "Failed to verify signed part: %s\n",
 242                          (err ? err->message : "no error explanation given"));
 243 #else
 244             /* For some reason the GMimeSignatureValidity returned
 245              * here is not a const (inconsistent with that
 246              * returned by
 247              * g_mime_multipart_encrypted_get_signature_validity,
 248              * and therefore needs to be properly disposed of.
 249              *
 250              * In GMime 2.6, they're both non-const, so we'll be able
 251              * to clean up this asymmetry. */
 252             GMimeSignatureValidity *sig_validity = g_mime_multipart_signed_verify
 253                 (GMIME_MULTIPART_SIGNED (part), cryptoctx, &err);
 254             node->verify_attempted = TRUE;
 255             node->sig_validity = sig_validity;
 256             if (sig_validity) {
 257                 GMimeSignatureValidity **proxy =
 258                     talloc (node, GMimeSignatureValidity *);
 259                 *proxy = sig_validity;
 260                 talloc_set_destructor (proxy, _signature_validity_free);
 261             }
 262 #endif
 263         }
 264     }
 265
 266 #ifdef GMIME_ATLEAST_26
 267     /* sig_list may be created in both above cases, so we need to
 268      * cleanly handle it here. */
 269     if (node->sig_list) {
 270         GMimeSignatureList **proxy = talloc (node, GMimeSignatureList *);
 271         *proxy = node->sig_list;
 272         talloc_set_destructor (proxy, _signature_list_free);
 273     }
 274 #endif
 275
 276 #ifndef GMIME_ATLEAST_26
 277     if (node->verify_attempted && !node->sig_validity)
 278         fprintf (stderr, "Failed to verify signed part: %s\n",
 279                  (err ? err->message : "no error explanation given"));
 280 #endif
 281
 282     if (err)
 283         g_error_free (err);
 284
 285     return node;
 286 }
 287
 288 mime_node_t *
 289 mime_node_child (mime_node_t *parent, int child)
 290 {
 291     GMimeObject *sub;
 292     mime_node_t *node;
 293
 294     if (!parent || !parent->part || child < 0 || child >= parent->nchildren)
 295         return NULL;
 296
 297     if (GMIME_IS_MULTIPART (parent->part)) {
 298         if (child == 1 && parent->decrypted_child)
 299             sub = parent->decrypted_child;
 300         else
 301             sub = g_mime_multipart_get_part
 302                 (GMIME_MULTIPART (parent->part), child);
 303     } else if (GMIME_IS_MESSAGE (parent->part)) {
 304         sub = g_mime_message_get_mime_part (GMIME_MESSAGE (parent->part));
 305     } else {
 306         /* This should have been caught by message_part_create */
 307         INTERNAL_ERROR ("Unexpected GMimeObject type: %s",
 308                         g_type_name (G_OBJECT_TYPE (parent->part)));
 309     }
 310     node = _mime_node_create (parent, sub);
 311
 312     if (child == parent->next_child && parent->next_part_num != -1) {
 313         /* We're traversing in depth-first order.  Record the child's
 314          * depth-first numbering. */
 315         node->part_num = parent->next_part_num;
 316         node->next_part_num = node->part_num + 1;
 317
 318         /* Prepare the parent for its next depth-first child. */
 319         parent->next_child++;
 320         parent->next_part_num = -1;
 321
 322         if (node->nchildren == 0) {
 323             /* We've reached a leaf, so find the parent that has more
 324              * children and set it up to number its next child. */
 325             mime_node_t *iter = node->parent;
 326             while (iter && iter->next_child == iter->nchildren)
 327                 iter = iter->parent;
 328             if (iter)
 329                 iter->next_part_num = node->part_num + 1;
 330         }
 331     }
 332
 333     return node;
 334 }
 335
 336 static mime_node_t *
 337 _mime_node_seek_dfs_walk (mime_node_t *node, int *n)
 338 {
 339     mime_node_t *ret = NULL;
 340     int i;
 341
 342     if (*n == 0)
 343         return node;
 344
 345     *n -= 1;
 346     for (i = 0; i < node->nchildren && !ret; i++) {
 347         mime_node_t *child = mime_node_child (node, i);
 348         ret = _mime_node_seek_dfs_walk (child, n);
 349         if (!ret)
 350             talloc_free (child);
 351     }
 352     return ret;
 353 }
 354
 355 mime_node_t *
 356 mime_node_seek_dfs (mime_node_t *node, int n)
 357 {
 358     if (n < 0)
 359         return NULL;
 360     return _mime_node_seek_dfs_walk (node, &n);
 361 }