7a/e3c4c67ca337299a315d0fe4ff9a4f7a41b830

   1 Return-Path: <amthrax@drake.mit.edu>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 097B3431FB6\r
   6         for <notmuch@notmuchmail.org>; Sun, 27 Nov 2011 18:21:50 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -0.7\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
  12         tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id AU6yqgmoiVYy for <notmuch@notmuchmail.org>;\r
  16         Sun, 27 Nov 2011 18:21:47 -0800 (PST)\r
  17 Received: from dmz-mailsec-scanner-8.mit.edu (DMZ-MAILSEC-SCANNER-8.MIT.EDU\r
  18         [18.7.68.37])\r
  19         by olra.theworths.org (Postfix) with ESMTP id 0FAAF429E33\r
  20         for <notmuch@notmuchmail.org>; Sun, 27 Nov 2011 18:21:37 -0800 (PST)\r
  21 X-AuditID: 12074425-b7f116d0000008fe-c3-4ed2f03191c1\r
  22 Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
  23         by dmz-mailsec-scanner-8.mit.edu (Symantec Messaging Gateway) with SMTP\r
  24         id 0A.34.02302.130F2DE4; Sun, 27 Nov 2011 21:21:37 -0500 (EST)\r
  25 Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
  26         by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id pAS2LaMj001946; \r
  27         Sun, 27 Nov 2011 21:21:36 -0500\r
  28 Received: from drake.mit.edu\r
  29         (209-6-116-242.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
  30         [209.6.116.242]) (authenticated bits=0)\r
  31         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
  32         by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id pAS2LZ93020662\r
  33         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
  34         Sun, 27 Nov 2011 21:21:36 -0500 (EST)\r
  35 Received: from amthrax by drake.mit.edu with local (Exim 4.76)\r
  36         (envelope-from <amthrax@drake.mit.edu>)\r
  37         id 1RUqqd-0003vd-6R; Sun, 27 Nov 2011 21:21:35 -0500\r
  38 From: Austin Clements <amdragon@MIT.EDU>\r
  39 To: notmuch@notmuchmail.org\r
  40 Subject: [PATCH 4/4] show: Rewrite show_message_body to use the MIME tree\r
  41         interface.\r
  42 Date: Sun, 27 Nov 2011 21:21:11 -0500\r
  43 Message-Id: <1322446871-14986-5-git-send-email-amdragon@mit.edu>\r
  44 X-Mailer: git-send-email 1.7.5.4\r
  45 In-Reply-To: <1322446871-14986-1-git-send-email-amdragon@mit.edu>\r
  46 References: <1322446871-14986-1-git-send-email-amdragon@mit.edu>\r
  47 X-Brightmail-Tracker:\r
  48  H4sIAAAAAAAAA+NgFjrHIsWRmVeSWpSXmKPExsUixCmqrGv44ZKfwe/dGhat3Z+ZLK5u7We3\r
  49         2LPPy+L6zZnMDiweZ7vbWT3unuby2DnrLrvHs1W3mANYorhsUlJzMstSi/TtErgyViy9ylpw\r
  50         xaei875CA+NWmy5GTg4JAROJxzu/sUHYYhIX7q0Hsrk4hAT2MUpMvrSbEcLZwChx//JDdpAq\r
  51         IYH7TBLXD/JAJOYDJU69YwVJsAloSGzbv5wRxBYRkJbYeXc2WJxZoE6ic+MZsGZhgRCJnceu\r
  52         gtksAqoSj7f/ZAKxeQUcJO7O6GKHOENB4teRVWC9nAKOEnObtjBDLHaQWLfsKOsERv4FjAyr\r
  53         GGVTcqt0cxMzc4pTk3WLkxPz8lKLdC30cjNL9FJTSjcxgoKN3UV1B+OEQ0qHGAU4GJV4eDde\r
  54         vuQnxJpYVlyZe4hRkoNJSZT3xTugEF9SfkplRmJxRnxRaU5q8SFGCQ5mJRHenqNAOd6UxMqq\r
  55         1KJ8mJQ0B4uSOO/rHQ5+QgLpiSWp2ampBalFMFkZDg4lCd6k90CNgkWp6akVaZk5JQhpJg5O\r
  56         kOE8QMNDQGp4iwsSc4sz0yHypxgVpcR5c0ASAiCJjNI8uF5YMnjFKA70ijBvOEgVDzCRwHW/\r
  57         AhrMBDSYY+YFkMEliQgpqQbGFt51wi61QSJLPr4Tu8Tpnzdh7/M880sCvxd8uPg8p591m8mO\r
  58         Q4Xbu9jYdAqmTGbaXZxf+1X5RFCbiP4d+f5fUVPOPlJ98jdXVOWqW/o76aZwU8Ota6b8mXef\r
  59         q1zVXUrjYM/TXXJVU1n2i3Id/Hj2MOPsKmPP5guvj6mxT/qfu0Tv5w39yxFlSizFGYmGWsxF\r
  60         xYkA1H4FSeECAAA=\r
  61 Cc: dkg@fifthhorseman.net\r
  62 X-BeenThere: notmuch@notmuchmail.org\r
  63 X-Mailman-Version: 2.1.13\r
  64 Precedence: list\r
  65 List-Id: "Use and development of the notmuch mail system."\r
  66         <notmuch.notmuchmail.org>\r
  67 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  68         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  69 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  70 List-Post: <mailto:notmuch@notmuchmail.org>\r
  71 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  72 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  73         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  74 X-List-Received-Date: Mon, 28 Nov 2011 02:21:50 -0000\r
  75 \r
  76 This removes all of the MIME traversal logic from show_message_body\r
  77 and leaves only its interaction with the format callbacks.\r
  78 \r
  79 Besides isolating concerns, since traversal happens behind a trivial\r
  80 interface, there is now much less code duplication in\r
  81 show_message_part.  Also, this uses mime_node_seek_dfs to start at the\r
  82 requested part, eliminating all of the logic about parts being\r
  83 selected or being in_zone (and reducing the "show state" to only a\r
  84 part counter).  notmuch_show_params_t no longer needs to be passed\r
  85 through the recursion because the only two fields that mattered\r
  86 (related to crypto) are now handled by the MIME tree.\r
  87 \r
  88 The few remaining complexities in show_message_part highlight\r
  89 irregularities in the format callbacks with respect to top-level\r
  90 messages and embedded message parts.\r
  91 \r
  92 Since this is a rewrite, the diff is not very enlightening.  It's\r
  93 easier to look at the old code and the new code side-by-side.\r
  94 ---\r
  95  show-message.c |  229 +++++++++++++-------------------------------------------\r
  96  1 files changed, 52 insertions(+), 177 deletions(-)\r
  97 \r
  98 diff --git a/show-message.c b/show-message.c\r
  99 index 09fa607..4560aea 100644\r
 100 --- a/show-message.c\r
 101 +++ b/show-message.c\r
 102 @@ -24,154 +24,54 @@\r
 103  \r
 104  typedef struct show_message_state {\r
 105      int part_count;\r
 106 -    int in_zone;\r
 107  } show_message_state_t;\r
 108  \r
 109  static void\r
 110 -show_message_part (GMimeObject *part,\r
 111 +show_message_part (mime_node_t *node,\r
 112                    show_message_state_t *state,\r
 113                    const notmuch_show_format_t *format,\r
 114 -                  notmuch_show_params_t *params,\r
 115                    int first)\r
 116  {\r
 117 -    GMimeObject *decryptedpart = NULL;\r
 118 -    int selected;\r
 119 +    /* Formatters expect the envelope for embedded message parts */\r
 120 +    GMimeObject *part = node->envelope_part ?\r
 121 +       GMIME_OBJECT (node->envelope_part) : node->part;\r
 122 +    int i;\r
 123 +\r
 124 +    if (!first)\r
 125 +       fputs (format->part_sep, stdout);\r
 126 +\r
 127 +    /* Format this part */\r
 128 +    if (format->part_start)\r
 129 +       format->part_start (part, &(state->part_count));\r
 130 +\r
 131 +    if (node->is_encrypted && format->part_encstatus)\r
 132 +       format->part_encstatus (node->decrypt_success);\r
 133 +\r
 134 +    if (node->is_signed && format->part_sigstatus)\r
 135 +       format->part_sigstatus (node->sig_validity);\r
 136 +\r
 137 +    format->part_content (part);\r
 138 +\r
 139 +    if (node->envelope_part) {\r
 140 +       fputs (format->header_start, stdout);\r
 141 +       if (format->header_message_part)\r
 142 +           format->header_message_part (GMIME_MESSAGE (node->part));\r
 143 +       fputs (format->header_end, stdout);\r
 144 +\r
 145 +       fputs (format->body_start, stdout);\r
 146 +    }\r
 147 +\r
 148 +    /* Recurse over the children */\r
 149      state->part_count += 1;\r
 150 +    for (i = 0; i < node->children; i++)\r
 151 +       show_message_part (mime_node_child (node, i), state, format, i == 0);\r
 152  \r
 153 -    if (! (GMIME_IS_PART (part) || GMIME_IS_MULTIPART (part) || GMIME_IS_MESSAGE_PART (part))) {\r
 154 -       fprintf (stderr, "Warning: Not displaying unknown mime part: %s.\n",\r
 155 -                g_type_name (G_OBJECT_TYPE (part)));\r
 156 -       return;\r
 157 -    }\r
 158 +    /* Finish this part */\r
 159 +    if (node->envelope_part)\r
 160 +       fputs (format->body_end, stdout);\r
 161  \r
 162 -    selected = (params->part <= 0 || state->part_count == params->part);\r
 163 -\r
 164 -    if (selected || state->in_zone) {\r
 165 -       if (!first && (params->part <= 0 || state->in_zone))\r
 166 -           fputs (format->part_sep, stdout);\r
 167 -\r
 168 -       if (format->part_start)\r
 169 -           format->part_start (part, &(state->part_count));\r
 170 -    }\r
 171 -\r
 172 -    /* handle PGP/MIME parts */\r
 173 -    if (GMIME_IS_MULTIPART (part) && params->cryptoctx) {\r
 174 -       GMimeMultipart *multipart = GMIME_MULTIPART (part);\r
 175 -       GError* err = NULL;\r
 176 -\r
 177 -       if (GMIME_IS_MULTIPART_ENCRYPTED (part) && params->decrypt)\r
 178 -       {\r
 179 -           if ( g_mime_multipart_get_count (multipart) != 2 ) {\r
 180 -               /* this violates RFC 3156 section 4, so we won't bother with it. */\r
 181 -               fprintf (stderr,\r
 182 -                        "Error: %d part(s) for a multipart/encrypted message (should be exactly 2)\n",\r
 183 -                        g_mime_multipart_get_count (multipart));\r
 184 -           } else {\r
 185 -               GMimeMultipartEncrypted *encrypteddata = GMIME_MULTIPART_ENCRYPTED (part);\r
 186 -               decryptedpart = g_mime_multipart_encrypted_decrypt (encrypteddata, params->cryptoctx, &err);\r
 187 -               if (decryptedpart) {\r
 188 -                   if ((selected || state->in_zone) && format->part_encstatus)\r
 189 -                       format->part_encstatus (1);\r
 190 -                   const GMimeSignatureValidity *sigvalidity = g_mime_multipart_encrypted_get_signature_validity (encrypteddata);\r
 191 -                   if (!sigvalidity)\r
 192 -                       fprintf (stderr, "Failed to verify signed part: %s\n", (err ? err->message : "no error explanation given"));\r
 193 -                   if ((selected || state->in_zone) && format->part_sigstatus)\r
 194 -                       format->part_sigstatus (sigvalidity);\r
 195 -               } else {\r
 196 -                   fprintf (stderr, "Failed to decrypt part: %s\n", (err ? err->message : "no error explanation given"));\r
 197 -                   if ((selected || state->in_zone) && format->part_encstatus)\r
 198 -                       format->part_encstatus (0);\r
 199 -               }\r
 200 -           }\r
 201 -       }\r
 202 -       else if (GMIME_IS_MULTIPART_SIGNED (part))\r
 203 -       {\r
 204 -           if ( g_mime_multipart_get_count (multipart) != 2 ) {\r
 205 -               /* this violates RFC 3156 section 5, so we won't bother with it. */\r
 206 -               fprintf (stderr,\r
 207 -                        "Error: %d part(s) for a multipart/signed message (should be exactly 2)\n",\r
 208 -                        g_mime_multipart_get_count (multipart));\r
 209 -           } else {\r
 210 -               /* For some reason the GMimeSignatureValidity returned\r
 211 -                * here is not a const (inconsistent with that\r
 212 -                * returned by\r
 213 -                * g_mime_multipart_encrypted_get_signature_validity,\r
 214 -                * and therefore needs to be properly disposed of.\r
 215 -                * Hopefully the API will become more consistent. */\r
 216 -               GMimeSignatureValidity *sigvalidity = g_mime_multipart_signed_verify (GMIME_MULTIPART_SIGNED (part), params->cryptoctx, &err);\r
 217 -               if (!sigvalidity) {\r
 218 -                   fprintf (stderr, "Failed to verify signed part: %s\n", (err ? err->message : "no error explanation given"));\r
 219 -               }\r
 220 -               if ((selected || state->in_zone) && format->part_sigstatus)\r
 221 -                   format->part_sigstatus (sigvalidity);\r
 222 -               if (sigvalidity)\r
 223 -                   g_mime_signature_validity_free (sigvalidity);\r
 224 -           }\r
 225 -       }\r
 226 -\r
 227 -       if (err)\r
 228 -           g_error_free (err);\r
 229 -    }\r
 230 -    /* end handle PGP/MIME parts */\r
 231 -\r
 232 -    if (selected || state->in_zone)\r
 233 -       format->part_content (part);\r
 234 -\r
 235 -    if (GMIME_IS_MULTIPART (part)) {\r
 236 -       GMimeMultipart *multipart = GMIME_MULTIPART (part);\r
 237 -       int i;\r
 238 -\r
 239 -       if (selected)\r
 240 -           state->in_zone = 1;\r
 241 -\r
 242 -       if (decryptedpart) {\r
 243 -           /* We emit the useless application/pgp-encrypted version\r
 244 -            * part here only to keep the emitted output as consistent\r
 245 -            * as possible between decrypted output and the\r
 246 -            * unprocessed multipart/mime. For some strange reason,\r
 247 -            * the actual encrypted data is the second part of the\r
 248 -            * multipart. */\r
 249 -           show_message_part (g_mime_multipart_get_part (multipart, 0), state, format, params, TRUE);\r
 250 -           show_message_part (decryptedpart, state, format, params, FALSE);\r
 251 -       } else {\r
 252 -           for (i = 0; i < g_mime_multipart_get_count (multipart); i++) {\r
 253 -               show_message_part (g_mime_multipart_get_part (multipart, i),\r
 254 -                                  state, format, params, i == 0);\r
 255 -           }\r
 256 -       }\r
 257 -\r
 258 -       if (selected)\r
 259 -           state->in_zone = 0;\r
 260 -\r
 261 -    } else if (GMIME_IS_MESSAGE_PART (part)) {\r
 262 -       GMimeMessage *mime_message = g_mime_message_part_get_message (GMIME_MESSAGE_PART (part));\r
 263 -\r
 264 -       if (selected)\r
 265 -           state->in_zone = 1;\r
 266 -\r
 267 -       if (selected || (!selected && state->in_zone)) {\r
 268 -           fputs (format->header_start, stdout);\r
 269 -           if (format->header_message_part)\r
 270 -               format->header_message_part (mime_message);\r
 271 -           fputs (format->header_end, stdout);\r
 272 -\r
 273 -           fputs (format->body_start, stdout);\r
 274 -       }\r
 275 -\r
 276 -       show_message_part (g_mime_message_get_mime_part (mime_message),\r
 277 -                          state, format, params, TRUE);\r
 278 -\r
 279 -       if (selected || (!selected && state->in_zone))\r
 280 -           fputs (format->body_end, stdout);\r
 281 -\r
 282 -       if (selected)\r
 283 -           state->in_zone = 0;\r
 284 -    }\r
 285 -\r
 286 -    if (selected || state->in_zone) {\r
 287 -       if (format->part_end)\r
 288 -           format->part_end (part);\r
 289 -    }\r
 290 +    if (format->part_end)\r
 291 +       format->part_end (part);\r
 292  }\r
 293  \r
 294  notmuch_status_t\r
 295 @@ -179,49 +79,24 @@ show_message_body (notmuch_message_t *message,\r
 296                    const notmuch_show_format_t *format,\r
 297                    notmuch_show_params_t *params)\r
 298  {\r
 299 -    GMimeStream *stream = NULL;\r
 300 -    GMimeParser *parser = NULL;\r
 301 -    GMimeMessage *mime_message = NULL;\r
 302 -    notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;\r
 303 -    const char *filename = notmuch_message_get_filename (message);\r
 304 -    FILE *file = NULL;\r
 305 +    notmuch_status_t ret;\r
 306      show_message_state_t state;\r
 307 +    mime_node_t *root, *part;\r
 308  \r
 309 -    state.part_count = 0;\r
 310 -    state.in_zone = 0;\r
 311 +    ret = mime_node_open (NULL, message, params->cryptoctx, params->decrypt,\r
 312 +                         &root);\r
 313 +    if (ret)\r
 314 +       return ret;\r
 315  \r
 316 -    file = fopen (filename, "r");\r
 317 -    if (! file) {\r
 318 -       fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));\r
 319 -       ret = NOTMUCH_STATUS_FILE_ERROR;\r
 320 -       goto DONE;\r
 321 -    }\r
 322 +    /* The caller of show_message_body has already handled the\r
 323 +     * outermost envelope, so skip it. */\r
 324 +    state.part_count = MAX (params->part, 1);\r
 325  \r
 326 -    stream = g_mime_stream_file_new (file);\r
 327 -    g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream), FALSE);\r
 328 +    part = mime_node_seek_dfs (root, state.part_count);\r
 329 +    if (part)\r
 330 +       show_message_part (part, &state, format, TRUE);\r
 331  \r
 332 -    parser = g_mime_parser_new_with_stream (stream);\r
 333 +    talloc_free (root);\r
 334  \r
 335 -    mime_message = g_mime_parser_construct_message (parser);\r
 336 -\r
 337 -    show_message_part (g_mime_message_get_mime_part (mime_message),\r
 338 -                      &state,\r
 339 -                      format,\r
 340 -                      params,\r
 341 -                      TRUE);\r
 342 -\r
 343 -  DONE:\r
 344 -    if (mime_message)\r
 345 -       g_object_unref (mime_message);\r
 346 -\r
 347 -    if (parser)\r
 348 -       g_object_unref (parser);\r
 349 -\r
 350 -    if (stream)\r
 351 -       g_object_unref (stream);\r
 352 -\r
 353 -    if (file)\r
 354 -       fclose (file);\r
 355 -\r
 356 -    return ret;\r
 357 +    return NOTMUCH_STATUS_SUCCESS;\r
 358  }\r
 359 -- \r
 360 1.7.5.4\r
 361 \r