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