THANKS: Solar Designer
[s-mailx.git] / mime-parse.c
blob3733c0e7130035c033818d89b9f6a5c60d64bdeb
1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Parse a message into a tree of struct mimepart objects.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
6 */
7 /*
8 * Copyright (c) 1980, 1993
9 * The Regents of the University of California. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
35 #undef n_FILE
36 #define n_FILE mime_parse
38 #ifndef HAVE_AMALGAMATION
39 # include "nail.h"
40 #endif
42 /* Fetch plain */
43 static char * _mime_parse_ct_plain_from_ct(char const *cth);
45 static bool_t _mime_parse_part(struct message *zmp, struct mimepart *ip,
46 enum mime_parse_flags mpf, int level);
48 static void _mime_parse_rfc822(struct message *zmp, struct mimepart *ip,
49 enum mime_parse_flags mpf, int level);
51 #ifdef HAVE_SSL
52 static void _mime_parse_pkcs7(struct message *zmp, struct mimepart *ip,
53 enum mime_parse_flags mpf, int level);
54 #endif
56 static bool_t _mime_parse_multipart(struct message *zmp,
57 struct mimepart *ip, enum mime_parse_flags mpf, int level);
58 static void __mime_parse_new(struct mimepart *ip, struct mimepart **np,
59 off_t offs, int *part);
60 static void __mime_parse_end(struct mimepart **np, off_t xoffs,
61 long lines);
63 static char *
64 _mime_parse_ct_plain_from_ct(char const *cth)
66 char *rv_b, *rv;
67 NYD2_ENTER;
69 rv_b = savestr(cth);
71 if ((rv = strchr(rv_b, ';')) != NULL)
72 *rv = '\0';
74 rv = rv_b + strlen(rv_b);
75 while (rv > rv_b && blankchar(rv[-1]))
76 --rv;
77 *rv = '\0';
78 NYD2_LEAVE;
79 return rv_b;
82 static bool_t
83 _mime_parse_part(struct message *zmp, struct mimepart *ip,
84 enum mime_parse_flags mpf, int level)
86 char *cp;
87 bool_t rv = FAL0;
88 NYD_ENTER;
90 ip->m_ct_type = hfield1("content-type", (struct message*)ip);
91 if (ip->m_ct_type != NULL)
92 ip->m_ct_type_plain = _mime_parse_ct_plain_from_ct(ip->m_ct_type);
93 else if (ip->m_parent != NULL && ip->m_parent->m_mimecontent == MIME_DIGEST)
94 ip->m_ct_type_plain = "message/rfc822";
95 else
96 ip->m_ct_type_plain = "text/plain";
97 ip->m_ct_type_usr_ovwr = NULL;
99 if (ip->m_ct_type != NULL)
100 ip->m_charset = mime_param_get("charset", ip->m_ct_type);
101 if (ip->m_charset == NULL)
102 ip->m_charset = ok_vlook(charset_7bit);
103 else
104 ip->m_charset = n_charsetalias_expand(ip->m_charset);
106 if ((ip->m_ct_enc = hfield1("content-transfer-encoding",
107 (struct message*)ip)) == NULL)
108 ip->m_ct_enc = mime_enc_from_conversion(CONV_7BIT);
109 ip->m_mime_enc = mime_enc_from_ctehead(ip->m_ct_enc);
111 if (((cp = hfield1("content-disposition", (struct message*)ip)) == NULL ||
112 (ip->m_filename = mime_param_get("filename", cp)) == NULL) &&
113 ip->m_ct_type != NULL)
114 ip->m_filename = mime_param_get("name", ip->m_ct_type);
116 if ((cp = hfield1("content-description", (struct message*)ip)) != NULL)
117 ip->m_content_description = cp;
119 if ((ip->m_mimecontent = n_mimetype_classify_part(ip)) == MIME_822) {
120 /* TODO (v15) HACK: message/rfc822 is treated special, that this one is
121 * TODO too stupid to apply content-decoding when (falsely) applied */
122 if (ip->m_mime_enc != MIMEE_8B && ip->m_mime_enc != MIMEE_7B) {
123 n_err(_("Pre-v15 %s cannot handle (falsely) encoded message/rfc822\n"
124 " (not 7bit or 8bit)! Interpreting as text/plain!\n"),
125 n_uagent);
126 ip->m_mimecontent = MIME_TEXT_PLAIN;
130 assert(ip->m_external_body_url == NULL);
131 if(!asccasecmp(ip->m_ct_type_plain, "message/external-body") &&
132 (cp = mime_param_get("access-type", ip->m_ct_type)) != NULL &&
133 !asccasecmp(cp, "URL"))
134 ip->m_external_body_url = mime_param_get("url", ip->m_ct_type);
136 if (mpf & MIME_PARSE_PARTS) {
137 if (level > 9999) { /* TODO MAGIC */
138 n_err(_("MIME content too deeply nested\n"));
139 goto jleave;
141 switch (ip->m_mimecontent) {
142 case MIME_PKCS7:
143 if (mpf & MIME_PARSE_DECRYPT) {
144 #ifdef HAVE_SSL
145 _mime_parse_pkcs7(zmp, ip, mpf, level);
146 if (ip->m_content_info & CI_ENCRYPTED_OK)
147 ip->m_content_info |= CI_EXPANDED;
148 break;
149 #else
150 n_err(_("No SSL / S/MIME support compiled in\n"));
151 goto jleave;
152 #endif
154 break;
155 default:
156 break;
157 case MIME_ALTERNATIVE:
158 case MIME_RELATED: /* TODO /related yet handled like /alternative */
159 case MIME_DIGEST:
160 case MIME_SIGNED:
161 case MIME_ENCRYPTED:
162 case MIME_MULTI:
163 if (!_mime_parse_multipart(zmp, ip, mpf, level))
164 goto jleave;
165 break;
166 case MIME_822:
167 _mime_parse_rfc822(zmp, ip, mpf, level);
168 break;
172 rv = TRU1;
173 jleave:
174 NYD_LEAVE;
175 return rv;
178 static void
179 _mime_parse_rfc822(struct message *zmp, struct mimepart *ip,
180 enum mime_parse_flags mpf, int level)
182 int c, lastc = '\n';
183 size_t cnt;
184 FILE *ibuf;
185 off_t offs;
186 struct mimepart *np;
187 long lines;
188 NYD_ENTER;
190 if ((ibuf = setinput(&mb, (struct message*)ip, NEED_BODY)) == NULL)
191 goto jleave;
193 cnt = ip->m_size;
194 lines = ip->m_lines;
195 while (cnt && ((c = getc(ibuf)) != EOF)) {
196 --cnt;
197 if (c == '\n') {
198 --lines;
199 if (lastc == '\n')
200 break;
202 lastc = c;
204 offs = ftell(ibuf);
206 np = csalloc(1, sizeof *np);
207 np->m_flag = MNOFROM;
208 np->m_content_info = CI_HAVE_HEADER | CI_HAVE_BODY;
209 np->m_block = mailx_blockof(offs);
210 np->m_offset = mailx_offsetof(offs);
211 np->m_size = np->m_xsize = cnt;
212 np->m_lines = np->m_xlines = lines;
213 np->m_partstring = ip->m_partstring;
214 np->m_parent = ip;
215 ip->m_multipart = np;
217 if (!(mpf & MIME_PARSE_SHALLOW) && ok_blook(rfc822_body_from_)) {
218 substdate((struct message*)np);
219 np->m_from = fakefrom((struct message*)np);/* TODO strip MNOFROM flag? */
222 _mime_parse_part(zmp, np, mpf, level + 1);
223 jleave:
224 NYD_LEAVE;
227 #ifdef HAVE_SSL
228 static void
229 _mime_parse_pkcs7(struct message *zmp, struct mimepart *ip,
230 enum mime_parse_flags mpf, int level)
232 struct message m, *xmp;
233 struct mimepart *np;
234 char *to, *cc;
235 NYD_ENTER;
237 memcpy(&m, ip, sizeof m);
238 to = hfield1("to", zmp);
239 cc = hfield1("cc", zmp);
241 if ((xmp = smime_decrypt(&m, to, cc, 0)) != NULL) {
242 np = csalloc(1, sizeof *np);
243 np->m_flag = xmp->m_flag;
244 np->m_content_info = xmp->m_content_info | CI_ENCRYPTED | CI_ENCRYPTED_OK;
245 np->m_block = xmp->m_block;
246 np->m_offset = xmp->m_offset;
247 np->m_size = xmp->m_size;
248 np->m_xsize = xmp->m_xsize;
249 np->m_lines = xmp->m_lines;
250 np->m_xlines = xmp->m_xlines;
252 /* TODO using part "1" for decrypted content is a hack */
253 if ((np->m_partstring = ip->m_partstring) == NULL)
254 ip->m_partstring = np->m_partstring = n_UNCONST(n_1);
256 if (_mime_parse_part(zmp, np, mpf, level + 1) == OKAY) {
257 ip->m_content_info |= CI_ENCRYPTED | CI_ENCRYPTED_OK;
258 np->m_parent = ip;
259 ip->m_multipart = np;
261 } else
262 ip->m_content_info |= CI_ENCRYPTED | CI_ENCRYPTED_BAD;
263 NYD_LEAVE;
265 #endif /* HAVE_SSL */
267 static bool_t
268 _mime_parse_multipart(struct message *zmp, struct mimepart *ip,
269 enum mime_parse_flags mpf, int level)
271 struct mimepart *np = NULL;
272 char *boundary, *line = NULL;
273 size_t linesize = 0, linelen, cnt, boundlen;
274 FILE *ibuf;
275 off_t offs;
276 int part = 0;
277 long lines = 0;
278 NYD_ENTER;
280 if ((boundary = mime_param_boundary_get(ip->m_ct_type, &linelen)) == NULL)
281 goto jleave;
283 boundlen = linelen;
284 if ((ibuf = setinput(&mb, (struct message*)ip, NEED_BODY)) == NULL)
285 goto jleave;
287 cnt = ip->m_size;
288 while (fgetline(&line, &linesize, &cnt, &linelen, ibuf, 0))
289 if (line[0] == '\n')
290 break;
291 offs = ftell(ibuf);
293 /* TODO using part "1" for decrypted content is a hack */
294 if (ip->m_partstring == NULL)
295 ip->m_partstring = n_UNCONST("1");
296 __mime_parse_new(ip, &np, offs, NULL);
298 while (fgetline(&line, &linesize, &cnt, &linelen, ibuf, 0)) {
299 /* XXX linelen includes LF */
300 if (!((lines > 0 || part == 0) && linelen > boundlen &&
301 !strncmp(line, boundary, boundlen))) {
302 ++lines;
303 continue;
306 /* Subpart boundary? */
307 if (line[boundlen] == '\n') {
308 offs = ftell(ibuf);
309 if (part > 0) {
310 __mime_parse_end(&np, offs - boundlen - 2, lines);
311 __mime_parse_new(ip, &np, offs - boundlen - 2, NULL);
313 __mime_parse_end(&np, offs, 2);
314 __mime_parse_new(ip, &np, offs, &part);
315 lines = 0;
316 continue;
319 /* Final boundary? Be aware of cases where there is no separating
320 * newline in between boundaries, as has been seen in a message with
321 * "Content-Type: multipart/appledouble;" */
322 if (linelen < boundlen + 2)
323 continue;
324 linelen -= boundlen + 2;
325 if (line[boundlen] != '-' || line[boundlen + 1] != '-' ||
326 (linelen > 0 && line[boundlen + 2] != '\n'))
327 continue;
328 offs = ftell(ibuf);
329 if (part != 0) {
330 __mime_parse_end(&np, offs - boundlen - 4, lines);
331 __mime_parse_new(ip, &np, offs - boundlen - 4, NULL);
333 __mime_parse_end(&np, offs + cnt, 2);
334 break;
336 if (np) {
337 offs = ftell(ibuf);
338 __mime_parse_end(&np, offs, lines);
341 for (np = ip->m_multipart; np != NULL; np = np->m_nextpart)
342 if (np->m_mimecontent != MIME_DISCARD)
343 _mime_parse_part(zmp, np, mpf, level + 1);
345 jleave:
346 if (line != NULL)
347 free(line);
348 NYD_LEAVE;
349 return TRU1;
352 static void
353 __mime_parse_new(struct mimepart *ip, struct mimepart **np, off_t offs,
354 int *part)
356 struct mimepart *pp;
357 size_t sz;
358 NYD_ENTER;
360 *np = csalloc(1, sizeof **np);
361 (*np)->m_flag = MNOFROM;
362 (*np)->m_content_info = CI_HAVE_HEADER | CI_HAVE_BODY;
363 (*np)->m_block = mailx_blockof(offs);
364 (*np)->m_offset = mailx_offsetof(offs);
366 if (part) {
367 ++(*part);
368 sz = (ip->m_partstring != NULL) ? strlen(ip->m_partstring) : 0;
369 sz += 20;
370 (*np)->m_partstring = salloc(sz);
371 if (ip->m_partstring)
372 snprintf((*np)->m_partstring, sz, "%s.%u", ip->m_partstring, *part);
373 else
374 snprintf((*np)->m_partstring, sz, "%u", *part);
375 } else
376 (*np)->m_mimecontent = MIME_DISCARD;
377 (*np)->m_parent = ip;
379 if (ip->m_multipart) {
380 for (pp = ip->m_multipart; pp->m_nextpart != NULL; pp = pp->m_nextpart)
382 pp->m_nextpart = *np;
383 } else
384 ip->m_multipart = *np;
385 NYD_LEAVE;
388 static void
389 __mime_parse_end(struct mimepart **np, off_t xoffs, long lines)
391 off_t offs;
392 NYD_ENTER;
394 offs = mailx_positionof((*np)->m_block, (*np)->m_offset);
395 (*np)->m_size = (*np)->m_xsize = xoffs - offs;
396 (*np)->m_lines = (*np)->m_xlines = lines;
397 *np = NULL;
398 NYD_LEAVE;
401 FL struct mimepart *
402 mime_parse_msg(struct message *mp, enum mime_parse_flags mpf)
404 struct mimepart *ip;
405 NYD_ENTER;
407 ip = csalloc(1, sizeof *ip);
408 ip->m_flag = mp->m_flag;
409 ip->m_content_info = mp->m_content_info;
410 ip->m_block = mp->m_block;
411 ip->m_offset = mp->m_offset;
412 ip->m_size = mp->m_size;
413 ip->m_xsize = mp->m_xsize;
414 ip->m_lines = mp->m_lines;
415 ip->m_xlines = mp->m_lines;
416 if (!_mime_parse_part(mp, ip, mpf, 0))
417 ip = NULL;
418 NYD_LEAVE;
419 return ip;
422 /* s-it-mode */