?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
nail.h: add struct sendbundle
[s-mailx.git] / nail.h
blobb3c397b1f582b170ed525041cca2eeccd8205532
1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Header inclusion, macros, constants, types and the global var declarations.
3 *
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2014 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
6 */
7 /*
8 * Copyright (c) 1980, 1993
9 * The Regents of the University of California. All rights reserved.
10 *
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. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * SUCH DAMAGE.
38 */
39
40 /*
41 * Mail -- a mail program
42 *
43 * Author: Kurt Shoens (UCB) March 25, 1978
44 */
45
46 #include "config.h"
47
48 #include <sys/stat.h>
49 #include <sys/types.h>
50
51 #include <errno.h>
52 #include <limits.h>
53 #include <setjmp.h>
54 #include <signal.h>
55 #include <stdarg.h>
56 #include <stdio.h>
57 #include <stdlib.h>
58 #include <string.h>
59 #include <termios.h>
60 #include <time.h>
61 #include <unistd.h>
62
63 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
64 # include <stdint.h>
65 #else
66 # include <inttypes.h>
67 #endif
68
69 #ifdef HAVE_C90AMEND1
70 # include <wchar.h>
71 # include <wctype.h>
72 #endif
73 #ifdef HAVE_DEBUG
74 # include <assert.h>
75 #endif
76 #ifdef HAVE_ICONV
77 # include <iconv.h>
78 #endif
79 #ifdef HAVE_REGEX
80 # include <regex.h>
81 #endif
82
83 #ifdef HAVE_OPENSSL_MD5
84 # include <openssl/md5.h>
85 #endif
86
87 /*
88 * Constants, some nail-specific macros
89 */
90
91 #if !defined NI_MAXHOST || NI_MAXHOST < 1025
92 # undef NI_MAXHOST
93 # define NI_MAXHOST 1025
94 #endif
95
96 #ifndef PATH_MAX
97 # ifdef MAXPATHLEN
98 # define PATH_MAX MAXPATHLEN
99 # else
100 # define PATH_MAX 1024 /* _XOPEN_PATH_MAX POSIX 2008/Cor 1-2013 */
101 # endif
102 #endif
103
104 #ifndef STDIN_FILENO
105 # define STDIN_FILENO 0
106 #endif
107 #ifndef STDOUT_FILENO
108 # define STDOUT_FILENO 1
109 #endif
110 #ifndef STDERR_FILENO
111 # define STDERR_FILENO 2
112 #endif
113
114 #ifdef NSIG_MAX
115 # undef NSIG
116 # define NSIG NSIG_MAX
117 #elif !defined NSIG
118 # define NSIG ((sizeof(sigset_t) * 8) - 1)
119 #endif
120
121 /* */
122
123 #if BUFSIZ > 2560 /* TODO simply use BUFSIZ? */
124 # define LINESIZE BUFSIZ /* max readable line width */
125 #else
126 # define LINESIZE 2560
127 #endif
128 #define BUFFER_SIZE (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
129
130 #define CBAD (-15555)
131 #define APPEND /* New mail goes to end of mailbox */
132 #define ESCAPE '~' /* Default escape for sending */
133 #define FIO_STACK_SIZE 20 /* Maximum recursion for sourcing */
134 #define HIST_SIZE 242 /* tty.c: history list default size */
135 #define HSHSIZE 23 /* Hash prime (aliases, vars, macros) */
136 #define MAXARGC 1024 /* Maximum list of raw strings */
137 #define MAXEXP 25 /* Maximum expansion of aliases */
138 #define NYD_CALLS_MAX 1000 /* Number of NYD calls that are remembered */
139 #define PROMPT_BUFFER_SIZE 80 /* getprompt() bufsize (> 3!) */
140
141 #define ACCOUNT_NULL "null" /* Name of "null" account */
142 #define MAILRC "~/.mailrc"
143 #define TMPDIR_FALLBACK "/tmp"
144
145 #define COLOUR_MSGINFO "fg=green"
146 #define COLOUR_PARTINFO "fg=brown"
147 #define COLOUR_FROM_ "fg=brown"
148 #define COLOUR_HEADER "fg=red"
149 #define COLOUR_UHEADER "ft=bold,fg=red"
150 #define COLOUR_PAGERS "less"
151 #define COLOUR_TERMS \
152 "cons25,linux,rxvt,rxvt-unicode,screen,sun,"\
153 "vt100,vt220,wsvt25,xterm,xterm-color"
154 #define COLOUR_USER_HEADERS "from,subject"
155
156 #define FROM_DATEBUF 64 /* Size of RFC 4155 From_ line date */
157 #define DATE_DAYSYEAR 365L
158 #define DATE_SECSMIN 60L
159 #define DATE_MINSHOUR 60L
160 #define DATE_HOURSDAY 24L
161 #define DATE_SECSDAY (DATE_SECSMIN * DATE_MINSHOUR * DATE_HOURSDAY)
162
163 /* Default *encoding* as enum conversion below */
164 #define MIME_DEFAULT_ENCODING CONV_TOQP
165
166 /* Maximum allowed line length in a mail before QP folding is necessary), and
167 * the real limit we go for */
168 #define MIME_LINELEN_MAX 1000
169 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 50)
170
171 /* Locations of mime.types(5) */
172 #define MIME_TYPES_USR "~/.mime.types"
173 #define MIME_TYPES_SYS "/etc/mime.types"
174
175 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set */
176 #define CHARSET_7BIT "US-ASCII"
177 #ifdef HAVE_ICONV
178 # define CHARSET_8BIT "UTF-8"
179 # define CHARSET_8BIT_OKEY charset_8bit
180 #else
181 # define CHARSET_8BIT "ISO-8859-1"
182 # define CHARSET_8BIT_OKEY ttycharset
183 #endif
184
185 /* Is *W* a quoting (ASCII only) character? */
186 #define ISQUOTE(W) \
187 ((W) == L'>' || (W) == L'|' || (W) == L'}' || (W) == L':')
188
189 /* Maximum number of quote characters (not bytes!) that'll be used on
190 * follow lines when compressing leading quote characters */
191 #define QUOTE_MAX 42
192
193 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
194 #define QUOTE_TAB_SPACES 8
195
196 /* Maximum size of a message that is passed through to the spam system */
197 #define SPAM_MAXSIZE 420000
198
199 /* String dope: dynamic buffer size, and size of the single builtin one that's
200 * used first */
201 #define SBUFFER_SIZE 0x18000u
202 #define SBUFFER_BUILTIN 0x2000u
203
204 /* These come from the configuration (named Xxy to not clash with sh(1)..) */
205 #ifndef XSHELL
206 # define XSHELL "/bin/sh"
207 #endif
208 #ifndef XLISTER
209 # define XLISTER "ls"
210 #endif
211 #ifndef XPAGER
212 # define XPAGER "more"
213 #endif
214
215 /*
216 * CC support, generic macros etc.
217 */
218
219 #undef __PREREQ
220 #if defined __GNUC__ || defined __clang__
221 # define __EXTEN __extension__
222 # ifdef __GNUC__
223 # define __PREREQ(X,Y) \
224 (__GNUC__ > (X) || (__GNUC__ == (X) && __GNUC_MINOR__ >= (Y)))
225 # else
226 # define __PREREQ(X,Y) 1
227 # endif
228 #else
229 # define __EXTEN
230 # define __PREREQ(X,Y) 0
231 #endif
232
233 #define EMPTY_FILE(F) typedef int CONCAT(avoid_empty_file__, F);
234
235 /* Pointer to size_t */
236 #define PTR2SIZE(X) ((size_t)(uintptr_t)(X))
237
238 /* Pointer comparison (types from below) */
239 #define PTRCMP(A,C,B) ((uintptr_t)(A) C (uintptr_t)(B))
240
241 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
242 * Note: doesn't sign-extend correctly, that's still up to the caller */
243 #define UICMP(T,A,C,B) ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
244
245 /* Members in constant array */
246 #ifndef NELEM
247 # define NELEM(A) (sizeof(A) / sizeof(A[0]))
248 #endif
249
250 /* sizeof() for member fields */
251 #define SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
252
253 /* Casts-away (*NOT* cast-away) */
254 #define UNUSED(X) ((void)(X))
255 #define UNCONST(P) ((void*)(uintptr_t)(void const*)(P))
256 #define UNVOLATILE(P) ((void*)(uintptr_t)(void volatile*)(P))
257 #define UNXXX(T,C,P) ((T)(uintptr_t)(C)(P))
258
259 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
260 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
261 # define STRING(X) #X
262 # define XSTRING(X) STRING(X)
263 # define CONCAT(S1,S2) _CONCAT(S1, S2)
264 # define _CONCAT(S1,S2) S1 ## S2
265 #else
266 # define STRING(X) "X"
267 # define XSTRING STRING
268 # define CONCAT(S1,S2) S1/**/S2
269 #endif
270
271 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
272 /* Variable size arrays and structure fields */
273 # define VFIELD_SIZE(X)
274 # define VFIELD_SIZEOF(T,F) (0)
275 /* Inline functions */
276 # define HAVE_INLINE
277 # define INLINE inline
278 # define SINLINE static inline
279 #else
280 # define VFIELD_SIZE(X) (X)
281 # define VFIELD_SIZEOF(T,F) SIZEOF_FIELD(T, F)
282 # if __PREREQ(2, 9)
283 # define INLINE static __inline
284 # define SINLINE static __inline
285 # else
286 # define INLINE
287 # define SINLINE static
288 # endif
289 #endif
290
291 #undef __FUN__
292 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
293 # define __FUN__ __func__
294 #elif __PREREQ(3, 4)
295 # define __FUN__ __FUNCTION__
296 #else
297 # define __FUN__ uagent /* Something that is not a literal */
298 #endif
299
300 #if defined __predict_true && defined __predict_false
301 # define LIKELY(X) __predict_true(X)
302 # define UNLIKELY(X) __predict_false(X)
303 #elif __PREREQ(2, 96)
304 # define LIKELY(X) __builtin_expect(X, 1)
305 # define UNLIKELY(X) __builtin_expect(X, 0)
306 #else
307 # define LIKELY(X) (X)
308 # define UNLIKELY(X) (X)
309 #endif
310
311 /* Compile-Time-Assert */
312 #define CTA(TEST) _CTA_1(TEST, __LINE__)
313 #define _CTA_1(TEST,L) _CTA_2(TEST, L)
314 #define _CTA_2(TEST,L) \
315 typedef char COMPILE_TIME_ASSERT_failed_at_line_ ## L[(TEST) ? 1 : -1]
316
317 #undef ISPOW2
318 #define ISPOW2(X) ((((X) - 1) & (X)) == 0)
319 #undef MIN
320 #define MIN(A, B) ((A) < (B) ? (A) : (B))
321 #undef MAX
322 #define MAX(A, B) ((A) < (B) ? (B) : (A))
323 #undef ABS
324 #define ABS(A) ((A) < 0 ? -(A) : (A))
325
326 #undef DBG
327 #undef NDBG
328 #ifndef HAVE_DEBUG
329 # undef assert
330 # define assert(X) UNUSED(0)
331 # define DBG(X)
332 # define NDBG(X) X
333 #else
334 # define DBG(X) X
335 # define NDBG(X)
336 #endif
337
338 /* Translation (init in main.c) */
339 #undef tr
340 #ifdef HAVE_CATGETS
341 # define CATSET 1
342 # define tr(c,d) catgets(catd, CATSET, c, d)
343 #else
344 # define tr(c,d) (d)
345 #endif
346
347 /*
348 * Types
349 */
350
351 /* TODO convert all integer types to the new [su]i(8|16|32|64)_t */
352 typedef unsigned long ul_it;
353 typedef unsigned int ui_it;
354 typedef unsigned short us_it;
355 typedef unsigned char uc_it;
356
357 typedef signed long sl_it;
358 typedef signed int si_it;
359 typedef signed short ss_it;
360 typedef signed char sc_it;
361
362 #ifdef UINT8_MAX
363 # define UI8_MAX UINT8_MAX
364 # define SI8_MIN INT8_MIN
365 # define SI8_MAX INT8_MAX
366 typedef uint8_t ui8_t;
367 typedef int8_t si8_t;
368 #elif UCHAR_MAX != 255
369 # error UCHAR_MAX must be 255
370 #else
371 # define UI8_MAX UCHAR_MAX
372 # define SI8_MIN CHAR_MIN
373 # define SI8_MAX CHAR_MAX
374 typedef unsigned char ui8_t;
375 typedef signed char si8_t;
376 #endif
377
378 #ifdef UINT16_MAX
379 # define UI16_MAX UINT16_MAX
380 # define SI16_MIN INT16_MIN
381 # define SI16_MAX INT16_MAX
382 typedef uint16_t ui16_t;
383 typedef int16_t si16_t;
384 #elif USHRT_MAX != 0xFFFFu
385 # error USHRT_MAX must be 0xFFFF
386 #else
387 # define UI16_MAX USHRT_MAX
388 # define SI16_MIN SHRT_MIN
389 # define SI16_MAX SHRT_MAX
390 typedef unsigned short ui16_t;
391 typedef signed short si16_t;
392 #endif
393
394 #ifdef UINT32_MAX
395 # define UI32_MAX UINT32_MAX
396 # define SI32_MIN INT32_MIN
397 # define SI32_MAX INT32_MAX
398 typedef uint32_t ui32_t;
399 typedef int32_t si32_t;
400 #elif ULONG_MAX == 0xFFFFFFFFu
401 # define UI32_MAX ULONG_MAX
402 # define SI32_MIN LONG_MIN
403 # define SI32_MAX LONG_MAX
404 typedef unsigned long int ui32_t;
405 typedef signed long int si32_t;
406 #elif UINT_MAX != 0xFFFFFFFFu
407 # error UINT_MAX must be 0xFFFFFFFF
408 #else
409 # define UI32_MAX UINT_MAX
410 # define SI32_MIN INT_MIN
411 # define SI32_MAX INT_MAX
412 typedef unsigned int ui32_t;
413 typedef signed int si32_t;
414 #endif
415
416 #ifdef UINT64_MAX
417 # define UI64_MAX UINT64_MAX
418 # define SI64_MIN INT64_MIN
419 # define SI64_MAX INT64_MAX
420 typedef uint64_t ui64_t;
421 #elif ULONG_MAX <= 0xFFFFFFFFu
422 # if !defined ULLONG_MAX || ULLONG_MAX != 0xFFFFFFFFFFFFFFFFu
423 # error We need a 64 bit integer
424 # else
425 # define UI64_MAX ULLONG_MAX
426 # define SI64_MIN LLONG_MIN
427 # define SI64_MAX LLONG_MAX
428 __EXTEN typedef unsigned long long ui64_t;
429 __EXTEN typedef signed long long si64_t;
430 # endif
431 #else
432 # define UI64_MAX ULONG_MAX
433 # define SI64_MIN LONG_MIN
434 # define SI64_MAX LONG_MAX
435 typedef unsigned long ui64_t;
436 typedef signed long si64_t;
437 #endif
438
439 /* (So that we can use UICMP() for size_t comparison, too) */
440 typedef size_t uiz_t;
441 typedef ssize_t siz_t;
442
443 #ifndef UINTPTR_MAX
444 # ifdef SIZE_MAX
445 # define uintptr_t size_t
446 # define UINTPTR_MAX SIZE_MAX
447 # else
448 # define uintptr_t unsigned long
449 # define UINTPTR_MAX ULONG_MAX
450 # endif
451 #endif
452
453 /* XXX Note we don't really deal with that the right way in that we pass size_t
454 * XXX arguments without casting; should do, because above we assert UINT_MAX
455 * XXX is indeed ui32_t -- CTAsserted in main.c */
456 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
457 # define ZFMT "zu"
458 # define __ZFMT_CTA() CTA(1 == 1)
459 #elif defined SIZE_MAX && SIZE_MAX == 0xFFFFFFFFu && ULONG_MAX != UINT_MAX
460 # define ZFMT "u"
461 # define __ZFMT_CTA() CTA(sizeof(size_t) == sizeof(unsigned int))
462 #endif
463 #ifndef ZFMT
464 # define ZFMT "lu"
465 # define __ZFMT_CTA() CTA(sizeof(size_t) == sizeof(unsigned long))
466 #endif
467
468 enum {FAL0, TRU1};
469 typedef si8_t bool_t;
470
471 typedef void ( *sighandler_type)(int);
472
473 enum user_options {
474 OPT_NONE,
475 OPT_DEBUG = 1u<< 0, /* -d / *debug* */
476 OPT_VERBOSE = 1u<< 1, /* -v / *verbose* */
477 OPT_EXISTONLY = 1u<< 2, /* -e */
478 OPT_HEADERSONLY = 1u<< 3, /* -H */
479 OPT_HEADERLIST = 1u<< 4, /* -L */
480 OPT_NOSRC = 1u<< 5, /* -n */
481 OPT_E_FLAG = 1u<< 6, /* -E / *skipemptybody* */
482 OPT_F_FLAG = 1u<< 7, /* -F */
483 OPT_N_FLAG = 1u<< 8, /* -N / *header* */
484 OPT_R_FLAG = 1u<< 9, /* -R */
485 OPT_r_FLAG = 1u<<10, /* -r (plus option_r_arg) */
486 OPT_t_FLAG = 1u<<11, /* -t */
487 OPT_u_FLAG = 1u<<12, /* -u given, or USER != getpwnam(3) */
488 OPT_TILDE_FLAG = 1u<<13, /* -~ */
489 OPT_BATCH_FLAG = 1u<<14, /* -# */
490
491 OPT_SENDMODE = 1u<<15, /* Usage case forces send mode */
492 OPT_INTERACTIVE = 1u<<16, /* isatty(0) */
493 OPT_TTYIN = OPT_INTERACTIVE,
494 OPT_TTYOUT = 1u<<17
495 };
496 #define IS_TTY_SESSION() \
497 ((options & (OPT_TTYIN | OPT_TTYOUT)) == (OPT_TTYIN | OPT_TTYOUT))
498
499 enum exit_status {
500 EXIT_OK = EXIT_SUCCESS,
501 EXIT_ERR = EXIT_FAILURE,
502 EXIT_USE = 2,
503 EXIT_COLL_ABORT = 1<<1, /* Message collection was aborted */
504 EXIT_SEND_ERROR = 1<<2 /* Unspecified send error occurred */
505 };
506
507 enum fexp_mode {
508 FEXP_FULL, /* Full expansion */
509 FEXP_LOCAL = 1<<0, /* Result must be local file/maildir */
510 FEXP_SHELL = 1<<1, /* No folder %,#,&,+ stuff, yet sh(1) */
511 FEXP_NSHORTCUT = 1<<2, /* Don't expand shortcuts */
512 FEXP_SILENT = 1<<3, /* Don't print but only return errors */
513 FEXP_MULTIOK = 1<<4 /* Expansion to many entries is ok */
514 };
515
516 enum flock_type {
517 FLOCK_READ,
518 FLOCK_WRITE,
519 FLOCK_UNLOCK
520 };
521
522 /* <0 means "stop" unless *prompt* extensions are enabled. */
523 enum prompt_exp {
524 PROMPT_STOP = -1, /* \c */
525 /* *prompt* extensions: \$, \@ etc. */
526 PROMPT_DOLLAR = -2,
527 PROMPT_AT = -3
528 };
529
530 enum colourspec {
531 COLOURSPEC_MSGINFO,
532 COLOURSPEC_PARTINFO,
533 COLOURSPEC_FROM_,
534 COLOURSPEC_HEADER,
535 COLOURSPEC_UHEADER,
536 COLOURSPEC_RESET
537 };
538
539 enum okay {
540 STOP = 0,
541 OKAY = 1
542 };
543
544 enum mimeenc {
545 MIME_NONE, /* message is not in MIME format */
546 MIME_BIN, /* message is in binary encoding */
547 MIME_8B, /* message is in 8bit encoding */
548 MIME_7B, /* message is in 7bit encoding */
549 MIME_QP, /* message is quoted-printable */
550 MIME_B64 /* message is in base64 encoding */
551 };
552
553 enum conversion {
554 CONV_NONE, /* no conversion */
555 CONV_7BIT, /* no conversion, is 7bit */
556 CONV_FROMQP, /* convert from quoted-printable */
557 CONV_TOQP, /* convert to quoted-printable */
558 CONV_8BIT, /* convert to 8bit (iconv) */
559 CONV_FROMB64, /* convert from base64 */
560 CONV_FROMB64_T, /* convert from base64/text */
561 CONV_TOB64, /* convert to base64 */
562 CONV_FROMHDR, /* convert from RFC1522 format */
563 CONV_TOHDR, /* convert to RFC1522 format */
564 CONV_TOHDR_A /* convert addresses for header */
565 };
566
567 enum sendaction {
568 SEND_MBOX, /* no conversion to perform */
569 SEND_RFC822, /* no conversion, no From_ line */
570 SEND_TODISP, /* convert to displayable form */
571 SEND_TODISP_ALL, /* same, include all MIME parts */
572 SEND_SHOW, /* convert to 'show' command form */
573 SEND_TOSRCH, /* convert for IMAP SEARCH */
574 SEND_TOFLTR, /* convert for spam mail filtering */
575 SEND_TOFILE, /* convert for saving body to a file */
576 SEND_TOPIPE, /* convert for pipe-content/subc. */
577 SEND_QUOTE, /* convert for quoting */
578 SEND_QUOTE_ALL, /* same, include all MIME parts */
579 SEND_DECRYPT /* decrypt */
580 };
581
582 enum mimecontent {
583 MIME_UNKNOWN, /* unknown content */
584 MIME_SUBHDR, /* inside a multipart subheader */
585 MIME_822, /* message/rfc822 content */
586 MIME_MESSAGE, /* other message/ content */
587 MIME_TEXT_PLAIN, /* text/plain content */
588 MIME_TEXT_HTML, /* text/html content */
589 MIME_TEXT, /* other text/ content */
590 MIME_ALTERNATIVE, /* multipart/alternative content */
591 MIME_DIGEST, /* multipart/digest content */
592 MIME_MULTI, /* other multipart/ content */
593 MIME_PKCS7, /* PKCS7 content */
594 MIME_DISCARD /* content is discarded */
595 };
596
597 /* Content-Transfer-Encodings as defined in RFC 2045:
598 * - Quoted-Printable, section 6.7
599 * - Base64, section 6.8 */
600 #define QP_LINESIZE (4 * 19) /* Max. compliant QP linesize */
601
602 #define B64_LINESIZE (4 * 19) /* Max. compliant Base64 linesize */
603 #define B64_ENCODE_INPUT_PER_LINE 57 /* Max. input for Base64 encode/line */
604
605 /* xxx QP came later, maybe rewrite all to use mimecte_flags directly? */
606 enum __mimecte_flags {
607 MIMECTE_NONE,
608 MIMECTE_SALLOC = 1<<0, /* Use salloc(), not srealloc().. */
609 /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
610 MIMECTE_BUF = 1<<1,
611 MIMECTE_CRLF = 1<<2, /* (encode) Append "\r\n" to lines */
612 MIMECTE_LF = 1<<3, /* (encode) Append "\n" to lines */
613 /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
614 * inject the desired line-ending whenever a linewrap is desired */
615 MIMECTE_MULTILINE = 1<<4,
616 /* (encode) Quote with header rules, do not generate soft NL breaks? */
617 MIMECTE_ISHEAD = 1<<5
618 };
619
620 enum qpflags {
621 QP_NONE = MIMECTE_NONE,
622 QP_SALLOC = MIMECTE_SALLOC,
623 QP_BUF = MIMECTE_BUF,
624 QP_ISHEAD = MIMECTE_ISHEAD
625 };
626
627 enum b64flags {
628 B64_NONE = MIMECTE_NONE,
629 B64_SALLOC = MIMECTE_SALLOC,
630 B64_BUF = MIMECTE_BUF,
631 B64_CRLF = MIMECTE_CRLF,
632 B64_LF = MIMECTE_LF,
633 B64_MULTILINE = MIMECTE_MULTILINE
634 };
635
636 enum oflags {
637 OF_RDONLY = 1<<0,
638 OF_WRONLY = 1<<1,
639 OF_RDWR = 1<<2,
640 OF_APPEND = 1<<3,
641 OF_CREATE = 1<<4,
642 OF_TRUNC = 1<<5,
643 OF_EXCL = 1<<6,
644 OF_CLOEXEC = 1<<7,
645 OF_UNLINK = 1<<8, /* Only for Ftmp(): unlink(2) after creation */
646 OF_HOLDSIGS = 1<<9, /* Mutual with OF_UNLINK - await Ftmp_free() */
647 OF_REGISTER = 1<<10 /* Register file in our file table */
648 };
649
650 enum tdflags {
651 TD_NONE, /* no display conversion */
652 TD_ISPR = 1<<0, /* use isprint() checks */
653 TD_ICONV = 1<<1, /* use iconv() */
654 TD_DELCTRL = 1<<2, /* delete control characters */
655
656 /*
657 * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
658 * enum sendaction, and may thus NOT clash with their bit range!
659 */
660 _TD_EOF = 1<<14, /* EOF seen, last round! */
661 _TD_BUFCOPY = 1<<15 /* Buffer may be constant, copy it */
662 };
663
664 enum protocol {
665 PROTO_FILE, /* refers to a local file */
666 PROTO_POP3, /* is a pop3 server string */
667 PROTO_IMAP, /* is an imap server string */
668 PROTO_MAILDIR, /* refers to a maildir folder */
669 PROTO_UNKNOWN /* unknown protocol */
670 };
671
672 enum cproto {
673 CPROTO_SMTP,
674 CPROTO_POP3,
675 CPROTO_IMAP
676 };
677
678 enum authtype {
679 AUTHTYPE_NONE = 1<<0,
680 AUTHTYPE_PLAIN = 1<<1, /* POP3: APOP is covered by this */
681 AUTHTYPE_LOGIN = 1<<2,
682 AUTHTYPE_CRAM_MD5 = 1<<3,
683 AUTHTYPE_GSSAPI = 1<<4,
684 AUTHTYPE_SASL = 1<<5 /* TODO */
685 };
686
687 #ifdef HAVE_SSL
688 enum ssl_verify_level {
689 SSL_VERIFY_IGNORE,
690 SSL_VERIFY_WARN,
691 SSL_VERIFY_ASK,
692 SSL_VERIFY_STRICT
693 };
694 #endif
695
696 /* A large enum with all the binary and value options a.k.a their keys.
697 * Only the constant keys are in here, to be looked up via ok_[bv]look(),
698 * ok_[bv]set() and ok_[bv]clear().
699 * Note: see the comments in acmava.c before changing *anything* in here! */
700 enum okeys {
701 /* Option keys for binary options */
702 ok_b_add_file_recipients,
703 ok_b_allnet,
704 ok_b_append,
705 ok_b_ask,
706 ok_b_askatend,
707 ok_b_askattach,
708 ok_b_askbcc,
709 ok_b_askcc,
710 ok_b_asksign,
711 ok_b_asksub,
712 ok_b_attachment_ask_content_description,
713 ok_b_attachment_ask_content_disposition,
714 ok_b_attachment_ask_content_id,
715 ok_b_attachment_ask_content_type,
716 ok_b_autocollapse,
717 ok_b_autoprint,
718 ok_b_autothread,
719 ok_b_bang,
720 ok_b_batch_exit_on_error,
721 ok_b_bsdannounce,
722 ok_b_bsdcompat,
723 ok_b_bsdflags,
724 ok_b_bsdheadline,
725 ok_b_bsdmsgs,
726 ok_b_bsdorder,
727 ok_b_bsdset,
728 ok_b_colour_disable,
729 ok_b_debug, /* {special=1} */
730 ok_b_disconnected,
731 ok_b_dot,
732 ok_b_editalong,
733 ok_b_editheaders,
734 ok_b_emptybox,
735 ok_b_emptystart,
736 ok_b_flipr,
737 ok_b_forward_as_attachment,
738 ok_b_fullnames,
739 ok_b_header, /* {special=1} */
740 ok_b_hold,
741 ok_b_idna_disable,
742 ok_b_ignore,
743 ok_b_ignoreeof,
744 ok_b_imap_use_starttls,
745 ok_b_keep,
746 ok_b_keep_content_length,
747 ok_b_keepsave,
748 ok_b_line_editor_disable,
749 ok_b_markanswered,
750 ok_b_message_id_disable,
751 ok_b_metoo,
752 ok_b_mime_allow_text_controls,
753 ok_b_mime_counter_evidence,
754 ok_b_outfolder,
755 ok_b_page,
756 ok_b_piperaw,
757 ok_b_pop3_bulk_load,
758 ok_b_pop3_no_apop,
759 ok_b_pop3_use_starttls,
760 ok_b_print_all_chars,
761 ok_b_print_alternatives,
762 ok_b_quiet,
763 ok_b_quote_as_attachment,
764 ok_b_recipients_in_cc,
765 ok_b_record_resent,
766 ok_b_reply_in_same_charset,
767 ok_b_Replyall,
768 ok_b_rfc822_body_from_, /* {name=rfc822-body-from_} */
769 ok_b_save,
770 ok_b_searchheaders,
771 ok_b_sendcharsets_else_ttycharset,
772 ok_b_sendwait,
773 ok_b_showlast,
774 ok_b_showname,
775 ok_b_showto,
776 ok_b_skipemptybody, /* {special=1} */
777 ok_b_smime_force_encryption,
778 ok_b_smime_no_default_ca,
779 ok_b_smime_sign,
780 ok_b_smtp_use_starttls,
781 ok_b_ssl_no_default_ca,
782 ok_b_ssl_v2_allow,
783 ok_b_v15_compat,
784 ok_b_verbose, /* {special=1} */
785 ok_b_writebackedited,
786
787 /* Option keys for values options */
788 ok_v_attrlist,
789 ok_v_autobcc,
790 ok_v_autocc,
791 ok_v_autosort,
792 ok_v_charset_7bit,
793 ok_v_charset_8bit,
794 ok_v_cmd,
795 ok_v_colour_pagers,
796 ok_v_colour_from_, /* {name=colour-from_} */
797 ok_v_colour_header,
798 ok_v_colour_msginfo,
799 ok_v_colour_partinfo,
800 ok_v_colour_terms,
801 ok_v_colour_uheader,
802 ok_v_colour_user_headers,
803 ok_v_crt,
804 ok_v_datefield,
805 ok_v_datefield_markout_older,
806 ok_v_DEAD,
807 ok_v_EDITOR,
808 ok_v_encoding,
809 ok_v_escape,
810 ok_v_folder, /* {special=1} */
811 ok_v_folder_hook,
812 ok_v_from,
813 ok_v_fwdheading,
814 ok_v_headline,
815 ok_v_hostname,
816 ok_v_imap_auth,
817 ok_v_imap_cache,
818 ok_v_imap_keepalive,
819 ok_v_imap_list_depth,
820 ok_v_indentprefix,
821 ok_v_line_editor_cursor_right, /* {special=1} */
822 ok_v_LISTER,
823 ok_v_MAIL,
824 ok_v_MBOX,
825 ok_v_mimetypes_load_control,
826 ok_v_NAIL_EXTRA_RC, /* {name=NAIL_EXTRA_RC} */
827 ok_v_NAIL_HEAD, /* {name=NAIL_HEAD} */
828 ok_v_NAIL_HISTFILE, /* {name=NAIL_HISTFILE} */
829 ok_v_NAIL_HISTSIZE, /* {name=NAIL_HISTSIZE} */
830 ok_v_NAIL_TAIL, /* {name=NAIL_TAIL} */
831 ok_v_newfolders,
832 ok_v_newmail,
833 ok_v_ORGANIZATION,
834 ok_v_PAGER,
835 ok_v_pop3_keepalive,
836 ok_v_prompt,
837 ok_v_quote,
838 ok_v_quote_fold,
839 ok_v_record,
840 ok_v_replyto,
841 ok_v_screen,
842 ok_v_sendcharsets,
843 ok_v_sender,
844 ok_v_sendmail,
845 ok_v_sendmail_progname,
846 ok_v_SHELL,
847 ok_v_Sign,
848 ok_v_sign,
849 ok_v_signature,
850 ok_v_smime_ca_dir,
851 ok_v_smime_ca_file,
852 ok_v_smime_crl_dir,
853 ok_v_smime_crl_file,
854 ok_v_smime_sign_cert,
855 ok_v_smime_sign_include_certs,
856 ok_v_smtp,
857 ok_v_smtp_auth,
858 ok_v_smtp_auth_password,
859 ok_v_smtp_auth_user,
860 ok_v_smtp_hostname,
861 ok_v_spam_command,
862 ok_v_spam_host,
863 ok_v_spam_maxsize,
864 ok_v_spam_port,
865 ok_v_spam_socket,
866 ok_v_spam_user,
867 ok_v_ssl_ca_dir,
868 ok_v_ssl_ca_file,
869 ok_v_ssl_cert,
870 ok_v_ssl_cipher_list,
871 ok_v_ssl_crl_dir,
872 ok_v_ssl_crl_file,
873 ok_v_ssl_key,
874 ok_v_ssl_method,
875 ok_v_ssl_rand_egd,
876 ok_v_ssl_rand_file,
877 ok_v_ssl_verify,
878 ok_v_stealthmua,
879 ok_v_toplines,
880 ok_v_ttycharset,
881 ok_v_VISUAL
882 };
883
884 /* Locale-independent character classes */
885 enum {
886 C_CNTRL = 0000,
887 C_BLANK = 0001,
888 C_WHITE = 0002,
889 C_SPACE = 0004,
890 C_PUNCT = 0010,
891 C_OCTAL = 0020,
892 C_DIGIT = 0040,
893 C_UPPER = 0100,
894 C_LOWER = 0200
895 };
896
897 struct str {
898 char *s; /* the string's content */
899 size_t l; /* the stings's length */
900 };
901
902 struct colour_table {
903 /* Plus a copy of *colour-user-headers* */
904 struct str ct_csinfo[COLOURSPEC_RESET+1 + 1];
905 };
906
907 struct url {
908 char const *url_input; /* Input as given (really) */
909 enum cproto url_cproto; /* Communication protocol as given */
910 bool_t url_needs_tls; /* Wether the protocol uses SSL/TLS */
911 bool_t url_had_user; /* Wether .url_user was part of the URL */
912 ui16_t url_portno; /* atoi .url_port or default, host endian */
913 char const *url_port; /* Port (if given) or NULL */
914 char url_proto[14]; /* Communication protocol as 'xy\0//' */
915 ui8_t url_proto_len; /* Length of .url_proto ('\0' index) */
916 ui8_t url_proto_xlen; /* .. if '\0' is replaced with ':' */
917 struct str url_user; /* User, urlxdec()oded */
918 struct str url_user_enc; /* User, urlxenc()oded */
919 struct str url_pass; /* Pass (urlxdec()oded) or NULL */
920 struct str url_pass_enc; /* Pass (urlxenc()oded) or NULL */
921 struct str url_host; /* Service hostname */
922 struct str url_path; /* CPROTO_IMAP: path suffix or NULL */
923 /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
924 struct str url_hp; /* .url_host[:.url_port] */
925 struct str url_uhp; /* .url_user_enc@.url_host[:.url_port] */
926 /* .url_user_enc@.url_host
927 * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
928 * *hostname*)! (And may later be overwritten according to *from*!) */
929 struct str url_uh;
930 char const *url_puhp; /* .url_proto://.url_uhp */
931 char const *url_puhpp; /* .url_proto://.url_uhp[/.url_path] */
932 };
933
934 struct ccred {
935 enum cproto cc_cproto; /* Communication protocol */
936 enum authtype cc_authtype; /* Desired authentication */
937 char const *cc_auth; /* Authentication type as string */
938 struct str cc_user; /* User (urlxdec()oded) or NULL */
939 struct str cc_pass; /* Password (urlxdec()oded) or NULL */
940 };
941
942 struct time_current {
943 time_t tc_time;
944 struct tm tc_gm;
945 struct tm tc_local;
946 char tc_ctime[32];
947 };
948
949 struct quoteflt {
950 FILE *qf_os; /* Output stream */
951 char const *qf_pfix;
952 ui32_t qf_pfix_len; /* Length of prefix: 0: bypass */
953 ui32_t qf_qfold_min; /* Simple way: wrote prefix? */
954 #ifdef HAVE_QUOTE_FOLD
955 ui32_t qf_qfold_max; /* Otherwise: line lengths */
956 ui8_t qf_state; /* *quote-fold* state machine */
957 bool_t qf_brk_isws; /* Breakpoint is at WS */
958 ui8_t __dummy[2];
959 ui32_t qf_wscnt; /* Whitespace count */
960 ui32_t qf_brkl; /* Breakpoint */
961 ui32_t qf_brkw; /* Visual width, breakpoint */
962 ui32_t qf_datw; /* Current visual output line width */
963 struct str qf_dat; /* Current visual output line */
964 struct str qf_currq; /* Current quote, compressed */
965 mbstate_t qf_mbps[2];
966 #endif
967 };
968
969 struct search_expr {
970 char const *ss_where; /* to search for the expression (not always used) */
971 char const *ss_sexpr; /* String search expression; NULL: use .ss_reexpr */
972 #ifdef HAVE_REGEX
973 regex_t ss_reexpr;
974 #endif
975 };
976
977 struct eval_ctx {
978 struct str ev_line;
979 bool_t ev_is_recursive; /* Evaluation in evaluation? (collect ~:) */
980 ui8_t __dummy[6];
981 bool_t ev_add_history; /* Enter (final) command in history? */
982 char const *ev_new_content; /* History: reenter line, start with this */
983 };
984
985 struct termios_state {
986 struct termios ts_tios;
987 char *ts_linebuf;
988 size_t ts_linesize;
989 bool_t ts_needs_reset;
990 };
991
992 #define termios_state_reset() \
993 do {\
994 if (termios_state.ts_needs_reset) {\
995 tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
996 termios_state.ts_needs_reset = FAL0;\
997 }\
998 } while (0)
999
1000 struct sock { /* data associated with a socket */
1001 int s_fd; /* file descriptor */
1002 #ifdef HAVE_SSL
1003 int s_use_ssl; /* SSL is used */
1004 # ifdef HAVE_OPENSSL
1005 void *s_ssl; /* SSL object */
1006 void *s_ctx; /* SSL context object */
1007 # endif
1008 #endif
1009 char *s_wbuf; /* for buffered writes */
1010 int s_wbufsize; /* allocated size of s_buf */
1011 int s_wbufpos; /* position of first empty data byte */
1012 char *s_rbufptr; /* read pointer to s_rbuf */
1013 int s_rsz; /* size of last read in s_rbuf */
1014 char const *s_desc; /* description of error messages */
1015 void (*s_onclose)(void); /* execute on close */
1016 char s_rbuf[LINESIZE + 1]; /* for buffered reads */
1017 };
1018
1019 struct sockconn {
1020 struct url sc_url;
1021 struct ccred sc_cred;
1022 struct sock sc_sock;
1023 };
1024
1025 struct mailbox {
1026 enum {
1027 MB_NONE = 000, /* no reply expected */
1028 MB_COMD = 001, /* command reply expected */
1029 MB_MULT = 002, /* multiline reply expected */
1030 MB_PREAUTH = 004, /* not in authenticated state */
1031 MB_BYE = 010 /* may accept a BYE state */
1032 } mb_active;
1033 FILE *mb_itf; /* temp file with messages, read open */
1034 FILE *mb_otf; /* same, write open */
1035 char *mb_sorted; /* sort method */
1036 enum {
1037 MB_VOID, /* no type (e. g. connection failed) */
1038 MB_FILE, /* local file */
1039 MB_POP3, /* POP3 mailbox */
1040 MB_IMAP, /* IMAP mailbox */
1041 MB_MAILDIR, /* maildir folder */
1042 MB_CACHE /* cached mailbox */
1043 } mb_type; /* type of mailbox */
1044 enum {
1045 MB_DELE = 01, /* may delete messages in mailbox */
1046 MB_EDIT = 02 /* may edit messages in mailbox */
1047 } mb_perm;
1048 int mb_compressed; /* is a compressed mbox file */
1049 int mb_threaded; /* mailbox has been threaded */
1050 #ifdef HAVE_IMAP
1051 enum mbflags {
1052 MB_NOFLAGS = 000,
1053 MB_UIDPLUS = 001 /* supports IMAP UIDPLUS */
1054 } mb_flags;
1055 unsigned long mb_uidvalidity; /* IMAP unique identifier validity */
1056 char *mb_imap_account; /* name of current IMAP account */
1057 char *mb_imap_pass; /* xxx v15-compat URL workaround */
1058 char *mb_imap_mailbox; /* name of current IMAP mailbox */
1059 char *mb_cache_directory; /* name of cache directory */
1060 #endif
1061 struct sock mb_sock; /* socket structure */
1062 };
1063
1064 enum needspec {
1065 NEED_UNSPEC, /* unspecified need, don't fetch */
1066 NEED_HEADER, /* need the header of a message */
1067 NEED_BODY /* need header and body of a message */
1068 };
1069
1070 enum havespec {
1071 HAVE_NOTHING, /* nothing downloaded yet */
1072 HAVE_HEADER = 01, /* header is downloaded */
1073 HAVE_BODY = 02 /* entire message is downloaded */
1074 };
1075
1076 /* flag bits. Attention: Flags that are used in cache.c may not change */
1077 enum mflag {
1078 MUSED = (1<< 0), /* entry is used, but this bit isn't */
1079 MDELETED = (1<< 1), /* entry has been deleted */
1080 MSAVED = (1<< 2), /* entry has been saved */
1081 MTOUCH = (1<< 3), /* entry has been noticed */
1082 MPRESERVE = (1<< 4), /* keep entry in sys mailbox */
1083 MMARK = (1<< 5), /* message is marked! */
1084 MODIFY = (1<< 6), /* message has been modified */
1085 MNEW = (1<< 7), /* message has never been seen */
1086 MREAD = (1<< 8), /* message has been read sometime. */
1087 MSTATUS = (1<< 9), /* message status has changed */
1088 MBOX = (1<<10), /* Send this to mbox, regardless */
1089 MNOFROM = (1<<11), /* no From line */
1090 MHIDDEN = (1<<12), /* message is hidden to user */
1091 MFULLYCACHED = (1<<13), /* message is completely cached */
1092 MBOXED = (1<<14), /* message has been sent to mbox */
1093 MUNLINKED = (1<<15), /* message was unlinked from cache */
1094 MNEWEST = (1<<16), /* message is very new (newmail) */
1095 MFLAG = (1<<17), /* message has been flagged recently */
1096 MUNFLAG = (1<<18), /* message has been unflagged */
1097 MFLAGGED = (1<<19), /* message is `flagged' */
1098 MANSWER = (1<<20), /* message has been answered recently */
1099 MUNANSWER = (1<<21), /* message has been unanswered */
1100 MANSWERED = (1<<22), /* message is `answered' */
1101 MDRAFT = (1<<23), /* message has been drafted recently */
1102 MUNDRAFT = (1<<24), /* message has been undrafted */
1103 MDRAFTED = (1<<25), /* message is marked as `draft' */
1104 MOLDMARK = (1<<26), /* messages was marked previously */
1105 MSPAM = (1<<27) /* message is classified as spam */
1106 };
1107 #define MMNORM (MDELETED | MSAVED | MHIDDEN)
1108 #define MMNDEL (MDELETED | MHIDDEN)
1109
1110 #define visible(mp) (((mp)->m_flag & MMNDEL) == 0)
1111
1112 struct mimepart {
1113 enum mflag m_flag; /* flags */
1114 enum havespec m_have; /* downloaded parts of the part */
1115 #ifdef HAVE_SPAM
1116 ui32_t m_spamscore; /* Spam score as int, 24:8 bits */
1117 #endif
1118 int m_block; /* block number of this part */
1119 size_t m_offset; /* offset in block of part */
1120 size_t m_size; /* Bytes in the part */
1121 size_t m_xsize; /* Bytes in the full part */
1122 long m_lines; /* Lines in the message */
1123 long m_xlines; /* Lines in the full message */
1124 time_t m_time; /* time the message was sent */
1125 char const *m_from; /* message sender */
1126 struct mimepart *m_nextpart; /* next part at same level */
1127 struct mimepart *m_multipart; /* parts of multipart */
1128 struct mimepart *m_parent; /* enclosing multipart part */
1129 char *m_ct_type; /* content-type */
1130 char *m_ct_type_plain; /* content-type without specs */
1131 enum mimecontent m_mimecontent; /* same in enum */
1132 char const *m_charset; /* charset */
1133 char *m_ct_transfer_enc; /* content-transfer-encoding */
1134 enum mimeenc m_mimeenc; /* same in enum */
1135 char *m_partstring; /* part level string */
1136 char *m_filename; /* attachment filename */
1137 };
1138
1139 struct message {
1140 enum mflag m_flag; /* flags */
1141 enum havespec m_have; /* downloaded parts of the message */
1142 #ifdef HAVE_SPAM
1143 ui32_t m_spamscore; /* Spam score as int, 24:8 bits */
1144 #endif
1145 int m_block; /* block number of this message */
1146 size_t m_offset; /* offset in block of message */
1147 size_t m_size; /* Bytes in the message */
1148 size_t m_xsize; /* Bytes in the full message */
1149 long m_lines; /* Lines in the message */
1150 long m_xlines; /* Lines in the full message */
1151 time_t m_time; /* time the message was sent */
1152 time_t m_date; /* time in the 'Date' field */
1153 unsigned m_idhash; /* hash on Message-ID for threads */
1154 struct message *m_child; /* first child of this message */
1155 struct message *m_younger; /* younger brother of this message */
1156 struct message *m_elder; /* elder brother of this message */
1157 struct message *m_parent; /* parent of this message */
1158 unsigned m_level; /* thread level of message */
1159 long m_threadpos; /* position in threaded display */
1160 #ifdef HAVE_IMAP
1161 unsigned long m_uid; /* IMAP unique identifier */
1162 #endif
1163 char *m_maildir_file; /* original maildir file of msg */
1164 ui32_t m_maildir_hash; /* hash of file name in maildir sub */
1165 int m_collapsed; /* collapsed thread information */
1166 };
1167
1168 /* Given a file address, determine the block number it represents */
1169 #define mailx_blockof(off) ((int) ((off) / 4096))
1170 #define mailx_offsetof(off) ((int) ((off) % 4096))
1171 #define mailx_positionof(block, offset) ((off_t)(block) * 4096 + (offset))
1172
1173 /* Argument types */
1174 enum argtype {
1175 ARG_MSGLIST = 0, /* Message list type */
1176 ARG_STRLIST = 1, /* A pure string */
1177 ARG_RAWLIST = 2, /* Shell string list */
1178 ARG_NOLIST = 3, /* Just plain 0 */
1179 ARG_NDMLIST = 4, /* Message list, no defaults */
1180 ARG_ECHOLIST = 5, /* Like raw list, but keep quote chars */
1181 ARG_ARGMASK = 7, /* Mask of the above */
1182
1183 ARG_A = 1u<< 4, /* Needs an active mailbox */
1184 ARG_F = 1u<< 5, /* Is a conditional command */
1185 ARG_H = 1u<< 6, /* Never place in history */
1186 ARG_I = 1u<< 7, /* Interactive command bit */
1187 ARG_M = 1u<< 8, /* Legal from send mode bit */
1188 ARG_P = 1u<< 9, /* Autoprint dot after command */
1189 ARG_R = 1u<<10, /* Cannot be called from collect / recursion */
1190 ARG_T = 1u<<11, /* Is a transparent command */
1191 ARG_V = 1u<<12, /* Places data in temporary_arg_v_store */
1192 ARG_W = 1u<<13 /* Illegal when read only bit */
1193 };
1194
1195 enum gfield {
1196 GTO = 1, /* Grab To: line */
1197 GSUBJECT = 2, /* Likewise, Subject: line */
1198 GCC = 4, /* And the Cc: line */
1199 GBCC = 8, /* And also the Bcc: line */
1200
1201 GNL = 16, /* Print blank line after */
1202 GDEL = 32, /* Entity removed from list */
1203 GCOMMA = 64, /* detract puts in commas */
1204 GUA = 128, /* User-Agent field */
1205 GMIME = 256, /* MIME 1.0 fields */
1206 GMSGID = 512, /* a Message-ID */
1207 /* 1024 */
1208 GIDENT = 2048, /* From:, Reply-To: and Organization: field */
1209 GREF = 4096, /* References: field */
1210 GDATE = 8192, /* Date: field */
1211 GFULL = 16384, /* include full names */
1212 GSKIN = 32768, /* skin names */
1213 GEXTRA = 65536, /* extra fields */
1214 GFILES = 131072 /* include filename addresses */
1215 };
1216 #define GMASK (GTO | GSUBJECT | GCC | GBCC)
1217
1218 /* Structure used to pass about the current state of a message (header) */
1219 struct header {
1220 struct name *h_to; /* Dynamic "To:" string */
1221 char *h_subject; /* Subject string */
1222 struct name *h_cc; /* Carbon copies string */
1223 struct name *h_bcc; /* Blind carbon copies */
1224 struct name *h_ref; /* References */
1225 struct attachment *h_attach; /* MIME attachments */
1226 char *h_charset; /* preferred charset */
1227 struct name *h_from; /* overridden "From:" field */
1228 struct name *h_replyto; /* overridden "Reply-To:" field */
1229 struct name *h_sender; /* overridden "Sender:" field */
1230 char *h_organization; /* overridden "Organization:" field */
1231 };
1232
1233 /* Handling of namelist nodes used in processing the recipients of mail and
1234 * aliases, inspection of mail-addresses and all that kind of stuff */
1235 enum nameflags {
1236 NAME_NAME_SALLOC = 1<< 0, /* .n_name is doped */
1237 NAME_FULLNAME_SALLOC = 1<< 1, /* .n_fullname is doped */
1238 NAME_SKINNED = 1<< 2, /* Is actually skin()ned */
1239 NAME_IDNA = 1<< 3, /* IDNA was applied */
1240 NAME_ADDRSPEC_CHECKED = 1<< 4, /* Address has been .. and */
1241 NAME_ADDRSPEC_ISFILE = 1<< 5, /* ..is a file path */
1242 NAME_ADDRSPEC_ISPIPE = 1<< 6, /* ..is a command for piping */
1243 NAME_ADDRSPEC_ISFILEORPIPE = NAME_ADDRSPEC_ISFILE | NAME_ADDRSPEC_ISPIPE,
1244 NAME_ADDRSPEC_ERR_EMPTY = 1<< 7, /* An empty string (or NULL) */
1245 NAME_ADDRSPEC_ERR_ATSEQ = 1<< 8, /* Weird @ sequence */
1246 NAME_ADDRSPEC_ERR_CHAR = 1<< 9, /* Invalid character */
1247 NAME_ADDRSPEC_ERR_IDNA = 1<<10, /* IDNA convertion failed */
1248 NAME_ADDRSPEC_INVALID = NAME_ADDRSPEC_ERR_EMPTY |
1249 NAME_ADDRSPEC_ERR_ATSEQ | NAME_ADDRSPEC_ERR_CHAR |
1250 NAME_ADDRSPEC_ERR_IDNA,
1251
1252 _NAME_SHIFTWC = 11,
1253 _NAME_MAXWC = 0xFFFFF,
1254 _NAME_MASKWC = _NAME_MAXWC << _NAME_SHIFTWC
1255 };
1256
1257 /* In the !_ERR_EMPTY case, the failing character can be queried */
1258 #define NAME_ADDRSPEC_ERR_GETWC(F) \
1259 ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
1260 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
1261 do {\
1262 (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
1263 (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
1264 } while (0)
1265
1266 struct name {
1267 struct name *n_flink; /* Forward link in list. */
1268 struct name *n_blink; /* Backward list link */
1269 enum gfield n_type; /* From which list it came */
1270 enum nameflags n_flags; /* enum nameflags */
1271 char *n_name; /* This fella's name */
1272 char *n_fullname; /* Sometimes, name including comment */
1273 };
1274
1275 struct addrguts {
1276 char const *ag_input; /* Input string as given */
1277 size_t ag_ilen; /* strlen() of input */
1278 size_t ag_iaddr_start; /* Start of *addr-spec* in .ag_input */
1279 size_t ag_iaddr_aend; /* ..and one past its end */
1280 char *ag_skinned; /* Output (alloced if !=.ag_input) */
1281 size_t ag_slen; /* strlen() of .ag_skinned */
1282 size_t ag_sdom_start; /* Start of domain in .ag_skinned, */
1283 enum nameflags ag_n_flags; /* enum nameflags of .ag_skinned */
1284 };
1285
1286 /* MIME attachments */
1287 enum attach_conv {
1288 AC_DEFAULT, /* _get_lc() -> _iter_*() */
1289 AC_FIX_OUTCS, /* _get_lc() -> "charset=" .a_charset */
1290 AC_FIX_INCS, /* "charset=".a_input_charset (nocnv) */
1291 AC_TMPFILE /* attachment.a_tmpf is converted */
1292 };
1293
1294 struct attachment {
1295 struct attachment *a_flink; /* Forward link in list. */
1296 struct attachment *a_blink; /* Backward list link */
1297 char const *a_name; /* file name */
1298 char const *a_content_type; /* content type */
1299 char const *a_content_disposition; /* content disposition */
1300 char const *a_content_id; /* content id */
1301 char const *a_content_description; /* content description */
1302 char const *a_input_charset; /* Interpretation depends on .a_conv */
1303 char const *a_charset; /* ... */
1304 FILE *a_tmpf; /* If AC_TMPFILE */
1305 enum attach_conv a_conv; /* User chosen conversion */
1306 int a_msgno; /* message number */
1307 };
1308
1309 struct sendbundle {
1310 struct header *sb_hp;
1311 struct name *sb_to;
1312 FILE *sb_input;
1313 struct str sb_signer; /* USER@HOST for signing+ */
1314 struct url sb_url;
1315 struct ccred sb_ccred;
1316 };
1317
1318 struct group {
1319 struct group *ge_link; /* Next person in this group */
1320 char *ge_name; /* This person's user name */
1321 };
1322
1323 struct grouphead {
1324 struct grouphead *g_link; /* Next grouphead in list */
1325 char *g_name; /* Name of this group */
1326 struct group *g_list; /* Users in group. */
1327 };
1328
1329 /* Structure of the hash table of ignored header fields */
1330 struct ignoretab {
1331 int i_count; /* Number of entries */
1332 struct ignore {
1333 struct ignore *i_link; /* Next ignored field in bucket */
1334 char *i_field; /* This ignored field */
1335 } *i_head[HSHSIZE];
1336 };
1337
1338 /* For the 'shortcut' and 'unshortcut' functionality */
1339 struct shortcut {
1340 struct shortcut *sh_next; /* next shortcut in list */
1341 char *sh_short; /* shortcut string */
1342 char *sh_long; /* expanded form */
1343 };
1344
1345 /* For saving the current directory and later returning */
1346 struct cw {
1347 #ifdef HAVE_FCHDIR
1348 int cw_fd;
1349 #else
1350 char cw_wd[PATH_MAX];
1351 #endif
1352 };
1353
1354 /*
1355 * Global variable declarations
1356 *
1357 * These become instantiated in main.c.
1358 */
1359
1360 #undef VL
1361 #ifdef _MAIN_SOURCE
1362 # ifndef HAVE_AMALGAMATION
1363 # define VL
1364 # else
1365 # define VL static
1366 # endif
1367 #else
1368 # define VL extern
1369 #endif
1370
1371 VL gid_t effectivegid; /* Saved from when we started up */
1372 VL gid_t realgid; /* Saved from when we started up */
1373
1374 VL int mb_cur_max; /* Value of MB_CUR_MAX */
1375 VL int realscreenheight; /* The real screen height */
1376 VL int scrnwidth; /* Screen width, or best guess */
1377 VL int scrnheight; /* Screen height/guess (4 header) */
1378 VL int utf8; /* Locale uses UTF-8 encoding */
1379 VL int enc_has_state; /* Encoding has shift states */
1380
1381 VL char **altnames; /* List of alternate names of user */
1382 VL char const *homedir; /* Path name of home directory */
1383 VL char const *myname; /* My login name */
1384 VL char const *progname; /* Our name */
1385 VL char const *tempdir; /* The temporary directory */
1386
1387 VL int exit_status; /* Exit status */
1388 VL int options; /* Bits of enum user_options */
1389 VL char *option_r_arg; /* Argument to -r option */
1390 VL char const **smopts; /* sendmail(1) opts from commline */
1391 VL size_t smopts_count; /* Entries in smopts */
1392
1393 /* TODO Join as many of these state machine bits into a single carrier! */
1394 VL int inhook; /* Currently executing a hook */
1395 VL bool_t exec_last_comm_error; /* Last execute() command failed */
1396 VL bool_t edit; /* Indicates editing a file */
1397 VL bool_t did_print_dot; /* Current message has been printed */
1398 VL bool_t list_saw_numbers; /* Last *LIST saw numerics */
1399 VL bool_t msglist_is_single; /* Last NDMLIST/MSGLIST chose 1 msg */
1400 VL bool_t loading; /* Loading user definitions */
1401 VL bool_t sourcing; /* Currently reading variant file */
1402 VL bool_t sawcom; /* Set after first command */
1403 VL bool_t starting; /* Still in startup code */
1404 VL bool_t var_clear_allow_undefined; /* v?ok_[bv]clear(): no complain */
1405 VL int noreset; /* String resets suspended */
1406
1407 /* XXX stylish sorting */
1408 VL int msgCount; /* Count of messages read in */
1409 VL struct mailbox mb; /* Current mailbox */
1410 VL int image; /* File descriptor for msg image */
1411 VL char mailname[PATH_MAX]; /* Name of current file */
1412 VL char displayname[80 - 40]; /* Prettyfied for display */
1413 VL char prevfile[PATH_MAX]; /* Name of previous file */
1414 VL char const *account_name; /* Current account name or NULL */
1415 VL off_t mailsize; /* Size of system mailbox */
1416 VL struct message *dot; /* Pointer to current message */
1417 VL struct message *prevdot; /* Previous current message */
1418 VL struct message *message; /* The actual message structure */
1419 VL struct message *threadroot; /* first threaded message */
1420 VL int imap_created_mailbox; /* hack to get feedback from imap */
1421
1422 VL struct grouphead *groups[HSHSIZE]; /* Pointer to active groups */
1423 VL struct ignoretab ignore[2]; /* ignored and retained fields
1424 * 0 is ignore, 1 is retain */
1425 VL struct ignoretab saveignore[2]; /* ignored and retained fields
1426 * on save to folder */
1427 VL struct ignoretab allignore[2]; /* special, ignore all headers */
1428 VL struct ignoretab fwdignore[2]; /* fields to ignore for forwarding */
1429 VL struct shortcut *shortcuts; /* list of shortcuts */
1430
1431 VL struct time_current time_current; /* time(3); send: mail1() XXXcarrier */
1432 VL struct termios_state termios_state; /* getpassword(); see commands().. */
1433
1434 #ifdef HAVE_COLOUR
1435 VL struct colour_table *colour_table;
1436 #endif
1437
1438 #ifdef HAVE_SSL
1439 VL enum ssl_verify_level ssl_verify_level; /* SSL verification level */
1440 #endif
1441
1442 #ifdef HAVE_ICONV
1443 VL iconv_t iconvd;
1444 #endif
1445
1446 #ifdef HAVE_CATGETS
1447 VL nl_catd catd;
1448 #endif
1449
1450 VL sigjmp_buf srbuf;
1451 VL int interrupts;
1452 VL sighandler_type dflpipe;
1453 VL sighandler_type handlerstacktop;
1454 #define handlerpush(f) (savedtop = handlerstacktop, handlerstacktop = (f))
1455 #define handlerpop() (handlerstacktop = savedtop)
1456
1457 /* TODO Temporary hacks unless the codebase doesn't jump and uses pass-by-value
1458 * TODO carrier structs instead of locals */
1459 VL char *temporary_arg_v_store;
1460 VL void *temporary_localopts_store;
1461
1462 /* The remaining variables need initialization */
1463
1464 #ifndef HAVE_AMALGAMATION
1465 VL char const month_names[12 + 1][4];
1466 VL char const weekday_names[7 + 1][4];
1467
1468 VL char const uagent[]; /* User agent */
1469 VL char const version[]; /* The version string */
1470 VL char const features[]; /* The "feature string" */
1471
1472 VL uc_it const class_char[];
1473 #endif
1474
1475 /*
1476 * Finally, let's include the function prototypes XXX embed
1477 */
1478
1479 #include "nailfuns.h"
1480
1481 /* vim:set fenc=utf-8:s-it-mode */
A mail processing system intended to provide the functionality of the POSIX mailx(1) command