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