Add *on-compose-{enter,leave}* hooks (Jens Schleusener, Rudolf Sykora)..
[s-mailx.git] / nail.h
blobd672092b0173b7c1d467ed91b4dbb5d25ad07d4e
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 - 2015 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. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
37 * Mail -- a mail program
39 * Author: Kurt Shoens (UCB) March 25, 1978
42 #include "config.h"
44 #include <sys/stat.h>
45 #include <sys/types.h>
47 #ifdef HAVE_GETTIMEOFDAY
48 # include <sys/time.h>
49 #endif
51 #include <errno.h>
52 #include <fcntl.h>
53 #include <limits.h>
54 #include <setjmp.h>
55 #include <signal.h>
56 #include <stdarg.h>
57 #include <stdio.h>
58 #include <stdlib.h>
59 #include <string.h>
60 #include <termios.h>
61 #include <time.h>
62 #include <unistd.h>
64 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
65 # include <stdint.h>
66 #else
67 # include <inttypes.h>
68 #endif
70 #ifdef HAVE_C90AMEND1
71 # include <wchar.h>
72 # include <wctype.h>
73 #endif
74 #ifdef HAVE_DEBUG
75 # include <assert.h>
76 #endif
77 #ifdef HAVE_ICONV
78 # include <iconv.h>
79 #endif
80 #ifdef HAVE_REGEX
81 # include <regex.h>
82 #endif
84 #ifdef HAVE_OPENSSL_MD5
85 # include <openssl/md5.h>
86 #endif
89 * Constants, some nail-specific macros
92 #if !defined 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 HOST_NAME_MAX
106 # ifdef _POSIX_HOST_NAME_MAX
107 # define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
108 # else
109 # define HOST_NAME_MAX 255
110 # endif
111 #endif
113 #ifndef NAME_MAX
114 # ifdef _POSIX_NAME_MAX
115 # define NAME_MAX _POSIX_NAME_MAX
116 # else
117 # define NAME_MAX 14
118 # endif
119 #endif
120 #if NAME_MAX < 8
121 # error NAME_MAX too small
122 #endif
124 #ifndef STDIN_FILENO
125 # define STDIN_FILENO 0
126 #endif
127 #ifndef STDOUT_FILENO
128 # define STDOUT_FILENO 1
129 #endif
130 #ifndef STDERR_FILENO
131 # define STDERR_FILENO 2
132 #endif
134 #ifdef NSIG_MAX
135 # undef NSIG
136 # define NSIG NSIG_MAX
137 #elif !defined NSIG
138 # define NSIG ((sizeof(sigset_t) * 8) - 1)
139 #endif
141 #ifdef O_CLOEXEC
142 # define _O_CLOEXEC O_CLOEXEC
143 # define _CLOEXEC_SET(FD) do {;} while(0)
144 #else
145 # define _O_CLOEXEC 0
146 # define _CLOEXEC_SET(FD) \
147 do { (void)fcntl((FD), F_SETFD, FD_CLOEXEC); } while (0)
148 #endif
150 /* */
152 #if BUFSIZ + 0 > 2560 /* TODO simply use BUFSIZ? */
153 # define LINESIZE BUFSIZ /* max readable line width */
154 #else
155 # define LINESIZE 2560
156 #endif
157 #define BUFFER_SIZE (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
159 /* Network protocol newline */
160 #define NETNL "\015\012"
161 #define NETLINE(X) X NETNL
163 /* Number of Not-Yet-Dead calls that are remembered */
164 #if defined HAVE_DEBUG || defined HAVE_DEVEL || defined HAVE_NYD2
165 # ifdef HAVE_NYD2
166 # define NYD_CALLS_MAX (25 * 84)
167 # elif defined HAVE_DEVEL
168 # define NYD_CALLS_MAX (25 * 42)
169 # else
170 # define NYD_CALLS_MAX (25 * 10)
171 # endif
172 #endif
174 #define APPEND /* New mail goes to end of mailbox */
175 #define CBAD (-15555)
176 #define DOTLOCK_TRIES 5 /* Number of open(2) calls for dotlock */
177 #define FILE_LOCK_TRIES 10 /* Maximum tries before file_lock() fails */
178 #define ERRORS_MAX 1000 /* Maximum error ring entries TODO configable*/
179 #define ESCAPE '~' /* Default escape for sending */
180 #define FIO_STACK_SIZE 20 /* Maximum recursion for sourcing */
181 #define HIST_SIZE 242 /* tty.c: history list default size */
182 #define HSHSIZE 23 /* Hash prime TODO make dynamic, obsolete */
183 #define MAXARGC 1024 /* Maximum list of raw strings */
184 #define MAXEXP 25 /* Maximum expansion of aliases */
185 #define PROMPT_BUFFER_SIZE 80 /* getprompt() bufsize (> 3!) */
186 #define REFERENCES_MAX 20 /* Maximum entries in References: */
187 #define FTMP_OPEN_TRIES 10 /* Maximum number of Ftmp() open(2) tries */
189 #define ACCOUNT_NULL "null" /* Name of "null" account */
190 #define MAILRC "~/.mailrc"
191 #define NETRC "~/.netrc"
192 #define TMPDIR_FALLBACK "/tmp"
194 /* Some environment variables for pipe hooks */
195 #define AGENT_USER "NAIL_USER"
196 #define AGENT_USER_ENC "NAIL_USER_ENC"
197 #define AGENT_HOST "NAIL_HOST"
198 #define AGENT_HOST_PORT "NAIL_HOST_PORT"
200 /* Colour stuff */
201 #ifdef HAVE_COLOUR
202 # define n_COLOUR(X) X
203 #else
204 # define n_COLOUR(X)
205 #endif
207 /* The n_COLOUR_TERMS is in addition to those which have "color" in their name!
208 * (Keep in SYNC: ./nail.h:n_COLOUR_TERMS, ./nail.1:*colour-terms*"!) */
209 #define n_COLOUR_TERMS \
210 "aterm,cons25,gnome,konsole,kterm,linux,"\
211 "rxvt,rxvt-unicode,screen,sun,vt100,vt220,wsvt25,xterm"
213 /* Special FD requests for run_command() / start_command() */
214 #define COMMAND_FD_PASS -1
215 #define COMMAND_FD_NULL -2
217 /* */
218 #define FROM_DATEBUF 64 /* Size of RFC 4155 From_ line date */
219 #define DATE_DAYSYEAR 365L
220 #define DATE_SECSMIN 60L
221 #define DATE_MINSHOUR 60L
222 #define DATE_HOURSDAY 24L
223 #define DATE_SECSDAY (DATE_SECSMIN * DATE_MINSHOUR * DATE_HOURSDAY)
225 /* *indentprefix* default as of POSIX */
226 #define INDENT_DEFAULT "\t"
228 /* Default *encoding* as enum mime_enc below */
229 #define MIME_DEFAULT_ENCODING MIMEE_QP
231 /* Maximum allowed line length in a mail before QP folding is necessary), and
232 * the real limit we go for */
233 #define MIME_LINELEN_MAX 998 /* Plus CRLF */
234 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 48)
236 /* Ditto, SHOULD */
237 #define MIME_LINELEN 78 /* Plus CRLF */
239 /* And in headers which contain an encoded word according to RFC 2047 there is
240 * yet another limit; also RFC 2045: 6.7, (5). */
241 #define MIME_LINELEN_RFC2047 76
243 /* Locations of mime.types(5) */
244 #define MIME_TYPES_USR "~/.mime.types"
245 #define MIME_TYPES_SYS "/etc/mime.types"
247 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set.
248 * (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!) */
249 #define CHARSET_7BIT "US-ASCII"
250 #ifdef HAVE_ICONV
251 # define CHARSET_8BIT "UTF-8"
252 # define CHARSET_8BIT_OKEY charset_8bit
253 #else
254 # define CHARSET_8BIT "ISO-8859-1"
255 # define CHARSET_8BIT_OKEY ttycharset
256 #endif
258 /* Some environment variables for pipe hooks etc. */
259 #define NAILENV_TMPDIR "NAIL_TMPDIR"
260 #define NAILENV_FILENAME "NAIL_FILENAME"
261 #define NAILENV_FILENAME_GENERATED "NAIL_FILENAME_GENERATED"
262 #define NAILENV_FILENAME_TEMPORARY "NAIL_FILENAME_TEMPORARY"
263 #define NAILENV_CONTENT "NAIL_CONTENT"
264 #define NAILENV_CONTENT_EVIDENCE "NAIL_CONTENT_EVIDENCE"
266 /* Is *W* a quoting (ASCII only) character? */
267 #define ISQUOTE(W) \
268 ((W) == L'>' || (W) == L'|' || (W) == L'}' || (W) == L':')
270 /* Maximum number of quote characters (not bytes!) that'll be used on
271 * follow lines when compressing leading quote characters */
272 #define QUOTE_MAX 42
274 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
275 #define QUOTE_TAB_SPACES 8
277 /* Maximum size of a message that is passed through to the spam system */
278 #define SPAM_MAXSIZE 420000
280 /* String dope: dynamic buffer size, and size of the single builtin one that's
281 * used first; note that these value include the size of the structure */
282 #define SBUFFER_SIZE ((0x10000u >> 1u) - 0x400)
283 #define SBUFFER_BUILTIN (0x10000u >> 1u)
285 /* These come from the configuration (named Xxy to not clash with sh(1)..) */
286 #ifndef XSHELL
287 # define XSHELL "/bin/sh"
288 #endif
289 #ifndef XLISTER
290 # define XLISTER "ls"
291 #endif
292 #ifndef XPAGER
293 # define XPAGER "more"
294 #endif
297 * OS, CC support, generic macros etc.
300 /* OS: we're not a library, only set what needs special treatment somewhere */
301 #define OS_DRAGONFLY 0
302 #define OS_SOLARIS 0
303 #define OS_SUNOS 0
305 #ifdef __DragonFly__
306 # undef OS_DRAGONFLY
307 # define OS_DRAGONFLY 1
308 #elif defined __solaris__ || defined __sun
309 # if defined __SVR4 || defined __svr4__
310 # undef OS_SOLARIS
311 # define OS_SOLARIS 1
312 # else
313 # undef OS_SUNOS
314 # define OS_SUNOS 1
315 # endif
316 #endif
318 /* CC */
319 #define CC_CLANG 0
320 #define PREREQ_CLANG(X,Y) 0
321 #define CC_GCC 0
322 #define PREREQ_GCC(X,Y) 0
323 #define CC_TCC 0
324 #define PREREQ_TCC(X,Y) 0
326 #ifdef __clang__
327 # undef CC_CLANG
328 # undef PREREQ_CLANG
329 # define CC_CLANG 1
330 # define PREREQ_CLANG(X,Y) \
331 (__clang_major__ + 0 > (X) || \
332 (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
333 # define __EXTEN __extension__
335 #elif defined __GNUC__
336 # undef CC_GCC
337 # undef PREREQ_GCC
338 # define CC_GCC 1
339 # define PREREQ_GCC(X,Y) \
340 (__GNUC__ + 0 > (X) || (__GNUC__ + 0 == (X) && __GNUC_MINOR__ + 0 >= (Y)))
341 # define __EXTEN __extension__
343 #elif defined __TINYC__
344 # undef CC_TCC
345 # define CC_TCC 1
346 #endif
348 #ifndef __EXTEN
349 # define __EXTEN
350 #endif
352 /* Suppress some technical warnings via #pragma's unless developing.
353 * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
354 #ifndef HAVE_DEVEL
355 # if PREREQ_CLANG(3, 4)
356 # pragma clang diagnostic ignored "-Wunused-result"
357 # pragma clang diagnostic ignored "-Wformat"
358 # elif PREREQ_GCC(4, 7)
359 # pragma GCC diagnostic ignored "-Wunused-local-typedefs"
360 # pragma GCC diagnostic ignored "-Wunused-result"
361 # pragma GCC diagnostic ignored "-Wformat"
362 # endif
363 #endif
365 /* For injection macros like DBG(), NATCH_CHAR() */
366 #define COMMA ,
368 #define EMPTY_FILE() typedef int CONCAT(avoid_empty_file__, n_FILE);
370 /* Pointer to size_t */
371 #define PTR2SIZE(X) ((size_t)(uintptr_t)(X))
373 /* Pointer comparison (types from below) */
374 #define PTRCMP(A,C,B) ((uintptr_t)(A) C (uintptr_t)(B))
376 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
377 * Note: doesn't sign-extend correctly, that's still up to the caller */
378 #define UICMP(T,A,C,B) ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
380 /* Align something to a size/boundary that cannot cause just any problem */
381 #define n_ALIGN(X) (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
383 /* Members in constant array */
384 #ifndef NELEM
385 # define NELEM(A) (sizeof(A) / sizeof(A[0]))
386 #endif
388 /* sizeof() for member fields */
389 #define SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
391 /* Casts-away (*NOT* cast-away) */
392 #define UNUSED(X) ((void)(X))
393 #define UNCONST(P) ((void*)(uintptr_t)(void const*)(P))
394 #define UNVOLATILE(P) ((void*)(uintptr_t)(void volatile*)(P))
395 #define UNXXX(T,C,P) ((T)(uintptr_t)(C)(P))
397 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
398 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
399 # define STRING(X) #X
400 # define XSTRING(X) STRING(X)
401 # define CONCAT(S1,S2) _CONCAT(S1, S2)
402 # define _CONCAT(S1,S2) S1 ## S2
403 #else
404 # define STRING(X) "X"
405 # define XSTRING STRING
406 # define CONCAT(S1,S2) S1/**/S2
407 #endif
409 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
410 # define n_FIELD_INITN(N) CONCAT(., N) =
411 # define n_FIELD_INITI(I) [I] =
412 #else
413 # define n_FIELD_INITN(N)
414 # define n_FIELD_INITI(N)
415 #endif
417 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
418 # define VFIELD_SIZE(X)
419 # define VFIELD_SIZEOF(T,F) (0)
420 # define VSTRUCT_SIZEOF(T,F) sizeof(T)
421 #else
422 # define VFIELD_SIZE(X) \
423 ((X) == 0 ? sizeof(size_t) \
424 : ((ssize_t)(X) < 0 ? sizeof(size_t) - ABS(X) : (size_t)(X)))
425 # define VFIELD_SIZEOF(T,F) SIZEOF_FIELD(T, F)
426 # define VSTRUCT_SIZEOF(T,F) (sizeof(T) - SIZEOF_FIELD(T, F))
427 #endif
429 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
430 # define HAVE_INLINE
431 # define INLINE inline
432 # define SINLINE static inline
433 #elif CC_CLANG || PREREQ_GCC(2, 9)
434 # define HAVE_INLINE
435 # define INLINE static __inline
436 # define SINLINE static __inline
437 #else
438 # define INLINE
439 # define SINLINE static
440 #endif
442 #undef __FUN__
443 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
444 # define __FUN__ __func__
445 #elif CC_CLANG || PREREQ_GCC(3, 4)
446 # define __FUN__ __extension__ __FUNCTION__
447 #else
448 # define __FUN__ uagent /* Something that is not a literal */
449 #endif
451 #if defined __predict_true && defined __predict_false
452 # define LIKELY(X) __predict_true(X)
453 # define UNLIKELY(X) __predict_false(X)
454 #elif CC_CLANG || PREREQ_GCC(2, 96)
455 # define LIKELY(X) __builtin_expect(X, 1)
456 # define UNLIKELY(X) __builtin_expect(X, 0)
457 #else
458 # define LIKELY(X) (X)
459 # define UNLIKELY(X) (X)
460 #endif
462 #undef HAVE_NATCH_CHAR
463 #undef NATCH_CHAR
464 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
465 # define HAVE_NATCH_CHAR
466 # define NATCH_CHAR(X) X
467 #else
468 # define NATCH_CHAR(X)
469 #endif
471 /* Compile-Time-Assert
472 * Problem is that some compilers warn on unused local typedefs, so add
473 * a special local CTA to overcome this */
474 #define CTA(TEST) _CTA_1(TEST, n_FILE, __LINE__)
475 #define LCTA(TEST) _LCTA_1(TEST, n_FILE, __LINE__)
477 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 201112L
478 # define n_CTA(T,M) _Static_assert(T, M)
479 # define n_LCTA(T,M) _Static_assert(T, M)
480 #else
481 # define n_CTA(T,M) _CTA_1(T, n_FILE, __LINE__)
482 # define n_LCTA(T,M) _LCTA_1(T, n_FILE, __LINE__)
483 #endif
484 #define n_CTAV(T) n_CTA(T, "Unexpected value of constant")
485 #define n_LCTAV(T) n_LCTA(T, "Unexpected value of constant")
487 #ifdef n_MAIN_SOURCE
488 # define n_MCTA(T,M) n_CTA(T, M);
489 #else
490 # define n_MCTA(T,M)
491 #endif
493 #define _CTA_1(T,F,L) _CTA_2(T, F, L)
494 #define _CTA_2(T,F,L) \
495 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
496 #define _LCTA_1(T,F,L) _LCTA_2(T, F, L)
497 #define _LCTA_2(T,F,L) \
498 do {\
499 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
500 ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
501 UNUSED(__i_am_unused__);\
502 } while (0)
504 #define UNINIT(N,V) N = V
506 #undef ISPOW2
507 #define ISPOW2(X) ((((X) - 1) & (X)) == 0)
508 #undef MIN
509 #define MIN(A, B) ((A) < (B) ? (A) : (B))
510 #undef MAX
511 #define MAX(A, B) ((A) < (B) ? (B) : (A))
512 #undef ABS
513 #define ABS(A) ((A) < 0 ? -(A) : (A))
515 #undef DBG
516 #undef NDBG
517 #ifndef HAVE_DEBUG
518 # undef assert
519 # define assert(X) UNUSED(0)
520 # define DBG(X)
521 # define NDBG(X) X
522 # define DBGOR(X,Y) Y
523 #else
524 # define DBG(X) X
525 # define NDBG(X)
526 # define DBGOR(X,Y) X
527 #endif
529 /* Translation (init in main.c) */
530 #undef _
531 #undef N_
532 #undef V_
533 #define _(S) S
534 #define N_(S) S
535 #define V_(S) S
538 * Types
541 #ifdef UINT8_MAX
542 # define UI8_MAX UINT8_MAX
543 # define SI8_MIN INT8_MIN
544 # define SI8_MAX INT8_MAX
545 typedef uint8_t ui8_t;
546 typedef int8_t si8_t;
547 #elif UCHAR_MAX != 255
548 # error UCHAR_MAX must be 255
549 #else
550 # define UI8_MAX UCHAR_MAX
551 # define SI8_MIN CHAR_MIN
552 # define SI8_MAX CHAR_MAX
553 typedef unsigned char ui8_t;
554 typedef signed char si8_t;
555 #endif
557 #if !defined PRIu8 || !defined PRId8
558 # undef PRIu8
559 # undef PRId8
560 # define PRIu8 "hhu"
561 # define PRId8 "hhd"
562 #endif
564 #ifdef UINT16_MAX
565 # define UI16_MAX UINT16_MAX
566 # define SI16_MIN INT16_MIN
567 # define SI16_MAX INT16_MAX
568 typedef uint16_t ui16_t;
569 typedef int16_t si16_t;
570 #elif USHRT_MAX != 0xFFFFu
571 # error USHRT_MAX must be 0xFFFF
572 #else
573 # define UI16_MAX USHRT_MAX
574 # define SI16_MIN SHRT_MIN
575 # define SI16_MAX SHRT_MAX
576 typedef unsigned short ui16_t;
577 typedef signed short si16_t;
578 #endif
580 #if !defined PRIu16 || !defined PRId16
581 # undef PRIu16
582 # undef PRId16
583 # if UI16_MAX == UINT_MAX
584 # define PRIu16 "u"
585 # define PRId16 "d"
586 # else
587 # define PRIu16 "hu"
588 # define PRId16 "hd"
589 # endif
590 #endif
592 #ifdef UINT32_MAX
593 # define UI32_MAX UINT32_MAX
594 # define SI32_MIN INT32_MIN
595 # define SI32_MAX INT32_MAX
596 typedef uint32_t ui32_t;
597 typedef int32_t si32_t;
598 #elif ULONG_MAX == 0xFFFFFFFFu
599 # define UI32_MAX ULONG_MAX
600 # define SI32_MIN LONG_MIN
601 # define SI32_MAX LONG_MAX
602 typedef unsigned long int ui32_t;
603 typedef signed long int si32_t;
604 #elif UINT_MAX != 0xFFFFFFFFu
605 # error UINT_MAX must be 0xFFFFFFFF
606 #else
607 # define UI32_MAX UINT_MAX
608 # define SI32_MIN INT_MIN
609 # define SI32_MAX INT_MAX
610 typedef unsigned int ui32_t;
611 typedef signed int si32_t;
612 #endif
614 #if !defined PRIu32 || !defined PRId32
615 # undef PRIu32
616 # undef PRId32
617 # if UI32_MAX == ULONG_MAX
618 # define PRIu32 "lu"
619 # define PRId32 "ld"
620 # else
621 # define PRIu32 "u"
622 # define PRId32 "d"
623 # endif
624 #endif
626 #ifdef UINT64_MAX
627 # define UI64_MAX UINT64_MAX
628 # define SI64_MIN INT64_MIN
629 # define SI64_MAX INT64_MAX
630 typedef uint64_t ui64_t;
631 typedef int64_t si64_t;
632 #elif ULONG_MAX <= 0xFFFFFFFFu
633 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
634 # error We need a 64 bit integer
635 # else
636 # define UI64_MAX ULLONG_MAX
637 # define SI64_MIN LLONG_MIN
638 # define SI64_MAX LLONG_MAX
639 __EXTEN typedef unsigned long long ui64_t;
640 __EXTEN typedef signed long long si64_t;
641 # endif
642 #else
643 # define UI64_MAX ULONG_MAX
644 # define SI64_MIN LONG_MIN
645 # define SI64_MAX LONG_MAX
646 typedef unsigned long ui64_t;
647 typedef signed long si64_t;
648 #endif
650 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64
651 # undef PRIu64
652 # undef PRId64
653 # undef PRIX64
654 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
655 # define PRIu64 "llu"
656 # define PRId64 "lld"
657 # define PRIX64 "llX"
658 # else
659 # define PRIu64 "lu"
660 # define PRId64 "ld"
661 # define PRIX64 "lX"
662 # endif
663 #endif
665 /* (So that we can use UICMP() for size_t comparison, too) */
666 typedef size_t uiz_t;
667 typedef ssize_t siz_t;
669 #undef PRIuZ
670 #undef PRIdZ
671 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
672 # define PRIuZ "zu"
673 # define PRIdZ "zd"
674 # define UIZ_MAX SIZE_MAX
675 #elif defined SIZE_MAX
676 /* UnixWare has size_t as unsigned as required but uses a signed limit
677 * constant (which is thus false!) */
678 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
679 # define PRIuZ PRIu64
680 # define PRIdZ PRId64
681 n_MCTA(sizeof(size_t) == sizeof(ui64_t),
682 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
683 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
684 # define PRIuZ PRIu32
685 # define PRIdZ PRId32
686 n_MCTA(sizeof(size_t) == sizeof(ui32_t),
687 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
688 # else
689 # error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
690 # endif
691 # define UIZ_MAX SIZE_MAX
692 #endif
693 #ifndef PRIuZ
694 # define PRIuZ "lu"
695 # define PRIdZ "ld"
696 n_MCTA(sizeof(size_t) == sizeof(unsigned long),
697 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
698 # define UIZ_MAX ULONG_MAX
699 #endif
701 #ifndef UINTPTR_MAX
702 # ifdef SIZE_MAX
703 # define uintptr_t size_t
704 # define UINTPTR_MAX SIZE_MAX
705 # else
706 # define uintptr_t unsigned long
707 # define UINTPTR_MAX ULONG_MAX
708 # endif
709 #endif
711 #if !defined PRIuPTR || !defined PRIXPTR
712 # undef PRIuPTR
713 # undef PRIXPTR
714 # if UINTPTR_MAX == ULONG_MAX
715 # define PRIuPTR "lu"
716 # define PRIXPTR "lX"
717 # else
718 # define PRIuPTR "u"
719 # define PRIXPTR "X"
720 # endif
721 #endif
723 enum {FAL0, TRU1, TRUM1 = -1};
724 typedef si8_t bool_t;
726 /* Add shorter aliases for "normal" integers */
727 typedef unsigned long ul_i;
728 typedef unsigned int ui_i;
729 typedef unsigned short us_i;
730 typedef unsigned char uc_i;
732 typedef signed long sl_i;
733 typedef signed int si_i;
734 typedef signed short ss_i;
735 typedef signed char sc_i;
737 typedef void ( *sighandler_type)(int);
739 enum authtype {
740 AUTHTYPE_NONE = 1<<0,
741 AUTHTYPE_PLAIN = 1<<1, /* POP3: APOP is covered by this */
742 AUTHTYPE_LOGIN = 1<<2,
743 AUTHTYPE_CRAM_MD5 = 1<<3,
744 AUTHTYPE_GSSAPI = 1<<4
747 enum expand_addr_flags {
748 EAF_NONE = 0, /* -> EAF_NOFILE | EAF_NOPIPE */
749 EAF_RESTRICT = 1<<0, /* "restrict" (do unless interaktive / -[~#]) */
750 EAF_FAIL = 1<<1, /* "fail" */
751 /* Bits reused by enum expand_addr_check_mode! */
752 EAF_FILE = 1<<3, /* +"file" targets */
753 EAF_PIPE = 1<<4, /* +"pipe" command pipe targets */
754 EAF_NAME = 1<<5, /* +"name"s (non-address) names / MTA aliases */
755 EAF_ADDR = 1<<6, /* +"addr" network address (contain "@") */
757 EAF_TARGET_MASK = EAF_FILE | EAF_PIPE | EAF_NAME | EAF_ADDR,
758 EAF_RESTRICT_TARGETS = EAF_NAME | EAF_ADDR /* (default set if not set) */
761 enum expand_addr_check_mode {
762 EACM_NONE = 0, /* Don't care about *expandaddr* */
763 EACM_NORMAL = 1<<0, /* Use our normal *expandaddr* checking */
764 EACM_STRICT = 1<<1, /* Never allow any file or pipe addresse */
765 EACM_MODE_MASK = 0x3, /* _NORMAL and _STRICT are mutual! */
767 EACM_NOLOG = 1<<2, /* Don't log check errors */
769 /* Some special overwrites of EAF_TARGETs.
770 * May NOT clash with EAF_* bits which may be ORd to these here! */
772 EACM_NONAME = 1<<16
775 #ifdef HAVE_COLOUR
776 /* We do have several groups of colour IDs; since only one of them can be
777 * active at any given time let's share the value range */
778 enum n_colour_group{
779 n_COLOUR_GROUP_SUM,
780 n_COLOUR_GROUP_VIEW,
781 n__COLOUR_GROUPS = 2
784 enum n_colour_id{
785 /* Header summary */
786 n_COLOUR_ID_SUM_DOTMARK = 0,
787 n_COLOUR_ID_SUM_HEADER,
788 n_COLOUR_ID_SUM_THREAD,
790 /* Message display */
791 n_COLOUR_ID_VIEW_FROM_ = 0,
792 n_COLOUR_ID_VIEW_HEADER,
793 n_COLOUR_ID_VIEW_MSGINFO,
794 n_COLOUR_ID_VIEW_PARTINFO,
796 n__COLOUR_IDS = n_COLOUR_ID_VIEW_PARTINFO + 1
799 /* Colour preconditions, let's call them tags, cannot be an enum because for
800 * message display they are the actual header name of the current header. Thus
801 * let's use constants of pseudo pointers */
802 # define n_COLOUR_TAG_SUM_DOT ((char*)-2)
803 # define n_COLOUR_TAG_SUM_OLDER ((char*)-3)
804 #endif /* HAVE_COLOUR */
806 enum conversion {
807 CONV_NONE, /* no conversion */
808 CONV_7BIT, /* no conversion, is 7bit */
809 CONV_FROMQP, /* convert from quoted-printable */
810 CONV_TOQP, /* convert to quoted-printable */
811 CONV_8BIT, /* convert to 8bit (iconv) */
812 CONV_FROMB64, /* convert from base64 */
813 CONV_FROMB64_T, /* convert from base64/text */
814 CONV_TOB64, /* convert to base64 */
815 CONV_FROMHDR, /* convert from RFC1522 format */
816 CONV_TOHDR, /* convert to RFC1522 format */
817 CONV_TOHDR_A /* convert addresses for header */
820 enum cproto {
821 CPROTO_SMTP,
822 CPROTO_POP3
825 enum dotlock_state {
826 DLS_NONE,
827 DLS_CANT_CHDIR, /* Failed to chdir(2) into desired path */
828 DLS_NAMETOOLONG, /* Lock file name would be too long */
829 DLS_ROFS, /* Read-only filesystem (no error, mailbox RO) */
830 DLS_NOPERM, /* No permission to creat lock file */
831 DLS_NOEXEC, /* Privilege separated dotlocker not found */
832 DLS_PRIVFAILED, /* Rising privileges failed in dotlocker */
833 DLS_EXIST, /* Lock file already exists, stale lock? */
834 DLS_FISHY, /* Something makes us think bad of situation */
835 DLS_DUNNO, /* Catch-all error */
836 DLS_PING, /* Not an error, but have to wait for lock */
837 DLS_ABANDON = 1<<7 /* ORd to any but _NONE: give up, don't retry */
840 enum exit_status {
841 EXIT_OK = EXIT_SUCCESS,
842 EXIT_ERR = EXIT_FAILURE,
843 EXIT_USE = 64, /* sysexits.h:EX_USAGE */
844 EXIT_NOUSER = 67, /* :EX_NOUSER */
845 EXIT_COLL_ABORT = 1<<1, /* Message collection was aborted */
846 EXIT_SEND_ERROR = 1<<2 /* Unspecified send error occurred */
849 enum fedit_mode {
850 FEDIT_NONE = 0,
851 FEDIT_SYSBOX = 1<<0, /* %: prefix */
852 FEDIT_RDONLY = 1<<1, /* Readonly (per-box, OPT_R_FLAG is global) */
853 FEDIT_NEWMAIL = 1<<2 /* `newmail' operation TODO OBSOLETE THIS! */
856 enum fexp_mode {
857 FEXP_FULL, /* Full expansion */
858 FEXP_LOCAL = 1<<0, /* Result must be local file/maildir */
859 FEXP_SHELL = 1<<1, /* No folder %,#,&,+ stuff, yet sh(1) */
860 FEXP_NSHORTCUT = 1<<2, /* Don't expand shortcuts */
861 FEXP_SILENT = 1<<3, /* Don't print but only return errors */
862 FEXP_MULTIOK = 1<<4, /* Expansion to many entries is ok */
863 FEXP_NSHELL = 1<<5 /* Don't do shell word exp. (but ~/, $VAR) */
866 enum file_lock_type {
867 FLT_READ,
868 FLT_WRITE
871 enum mimecontent {
872 MIME_UNKNOWN, /* unknown content */
873 MIME_SUBHDR, /* inside a multipart subheader */
874 MIME_822, /* message/rfc822 content */
875 MIME_MESSAGE, /* other message/ content */
876 MIME_TEXT_PLAIN, /* text/plain content */
877 MIME_TEXT_HTML, /* text/html content */
878 MIME_TEXT, /* other text/ content */
879 MIME_ALTERNATIVE, /* multipart/alternative content */
880 MIME_RELATED, /* mime/related (RFC 2387) */
881 MIME_DIGEST, /* multipart/digest content */
882 MIME_MULTI, /* other multipart/ content */
883 MIME_PKCS7, /* PKCS7 content */
884 MIME_DISCARD /* content is discarded */
887 enum mime_counter_evidence {
888 MIMECE_NONE,
889 MIMECE_SET = 1<<0, /* *mime-counter-evidence* was set */
890 MIMECE_BIN_OVWR = 1<<1, /* appli../octet-stream: check, ovw if possible */
891 MIMECE_ALL_OVWR = 1<<2, /* all: check, ovw if possible */
892 MIMECE_BIN_PARSE = 1<<3 /* appli../octet-stream: classify contents last */
895 /* Content-Transfer-Encodings as defined in RFC 2045:
896 * - Quoted-Printable, section 6.7
897 * - Base64, section 6.8 */
898 #define QP_LINESIZE (4 * 19) /* Max. compliant QP linesize */
900 #define B64_LINESIZE (4 * 19) /* Max. compliant Base64 linesize */
901 #define B64_ENCODE_INPUT_PER_LINE 57 /* Max. input for Base64 encode/line */
903 enum mime_enc {
904 MIMEE_NONE, /* message is not in MIME format */
905 MIMEE_BIN, /* message is in binary encoding */
906 MIMEE_8B, /* message is in 8bit encoding */
907 MIMEE_7B, /* message is in 7bit encoding */
908 MIMEE_QP, /* message is quoted-printable */
909 MIMEE_B64 /* message is in base64 encoding */
912 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
913 enum mime_enc_flags {
914 MIMEEF_NONE,
915 MIMEEF_SALLOC = 1<<0, /* Use salloc(), not srealloc().. */
916 /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
917 MIMEEF_BUF = 1<<1,
918 MIMEEF_CRLF = 1<<2, /* (encode) Append "\r\n" to lines */
919 MIMEEF_LF = 1<<3, /* (encode) Append "\n" to lines */
920 /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
921 * inject the desired line-ending whenever a linewrap is desired */
922 MIMEEF_MULTILINE = 1<<4,
923 /* (encode) Quote with header rules, do not generate soft NL breaks?
924 * For mustquote(), specifies wether special RFC 2047 header rules
925 * should be used instead */
926 MIMEEF_ISHEAD = 1<<5,
927 /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
928 * that characters which would not be reported as "must-quote" when
929 * detecting wether quoting is necessary at all will be reported as
930 * "must-quote" if they have to be encoded in an encoded word */
931 MIMEEF_ISENCWORD = 1<<6,
932 __MIMEEF_LAST = 6
935 enum qpflags {
936 QP_NONE = MIMEEF_NONE,
937 QP_SALLOC = MIMEEF_SALLOC,
938 QP_BUF = MIMEEF_BUF,
939 QP_ISHEAD = MIMEEF_ISHEAD,
940 QP_ISENCWORD = MIMEEF_ISENCWORD
943 enum b64flags {
944 B64_NONE = MIMEEF_NONE,
945 B64_SALLOC = MIMEEF_SALLOC,
946 B64_BUF = MIMEEF_BUF,
947 B64_CRLF = MIMEEF_CRLF,
948 B64_LF = MIMEEF_LF,
949 B64_MULTILINE = MIMEEF_MULTILINE,
950 /* Not used, but for clarity only */
951 B64_ISHEAD = MIMEEF_ISHEAD,
952 B64_ISENCWORD = MIMEEF_ISENCWORD,
953 /* Special version of Base64, "Base64URL", according to RFC 4648.
954 * Only supported for encoding! */
955 B64_RFC4648URL = 1<<(__MIMEEF_LAST+1),
956 /* Don't use any ("=") padding;
957 * may NOT be used with any of _CRLF, _LF or _MULTILINE */
958 B64_NOPAD = 1<<(__MIMEEF_LAST+2)
961 enum mime_parse_flags {
962 MIME_PARSE_NONE = 0,
963 MIME_PARSE_DECRYPT = 1<<0,
964 MIME_PARSE_PARTS = 1<<1
967 enum mime_handler_flags {
968 MIME_HDL_NULL, /* No pipe- mimetype handler, go away */
969 MIME_HDL_CMD, /* Normal command */
970 MIME_HDL_TEXT, /* @ special cmd to force treatment as text */
971 MIME_HDL_PTF, /* A special pointer-to-function handler */
972 MIME_HDL_MSG, /* Display msg (returned as command string) */
973 MIME_HDL_TYPE_MASK = 7,
974 MIME_HDL_ISQUOTE = 1<<4, /* Is quote action (we have info, keep it!) */
975 MIME_HDL_NOQUOTE = 1<<5, /* No MIME for quoting */
976 MIME_HDL_ALWAYS = 1<<6, /* Handler shall run for multi-msg actions */
977 MIME_HDL_ASYNC = 1<<7, /* Should run asynchronously */
978 MIME_HDL_NEEDSTERM = 1<<8, /* Takes over terminal */
979 MIME_HDL_TMPF = 1<<9, /* Create temporary file (zero-sized) */
980 MIME_HDL_TMPF_FILL = 1<<10, /* Fill in the msg body content */
981 MIME_HDL_TMPF_UNLINK = 1<<11 /* Delete it later again */
984 enum mlist_state {
985 MLIST_OTHER = 0, /* Normal address */
986 MLIST_KNOWN = 1, /* A known `mlist' */
987 MLIST_SUBSCRIBED = -1 /* A `mlsubscribe'd list */
990 enum oflags {
991 OF_RDONLY = 1<<0,
992 OF_WRONLY = 1<<1,
993 OF_RDWR = 1<<2,
994 OF_APPEND = 1<<3,
995 OF_CREATE = 1<<4,
996 OF_TRUNC = 1<<5,
997 OF_EXCL = 1<<6,
998 OF_CLOEXEC = 1<<7, /* TODO not used, always implied! CHANGE!! */
999 OF_UNLINK = 1<<8, /* Only for Ftmp(): unlink(2) after creation */
1000 OF_HOLDSIGS = 1<<9, /* Mutual with OF_UNLINK - await Ftmp_free() */
1001 OF_REGISTER = 1<<10, /* Register file in our file table */
1002 OF_REGISTER_UNLINK = 1<<11, /* unlink(2) upon unreg.; _REGISTER asserted! */
1003 OF_SUFFIX = 1<<12 /* Ftmp() name hint is mandatory! extension! */
1006 enum okay {
1007 STOP = 0,
1008 OKAY = 1
1011 enum okey_xlook_mode {
1012 OXM_PLAIN = 1<<0, /* Plain key always tested */
1013 OXM_H_P = 1<<1, /* Check PLAIN-.url_h_p */
1014 OXM_U_H_P = 1<<2, /* Check PLAIN-.url_u_h_p */
1015 OXM_ALL = 0x7
1018 /* <0 means "stop" unless *prompt* extensions are enabled. */
1019 enum prompt_exp {
1020 PROMPT_STOP = -1, /* \c */
1021 /* *prompt* extensions: \$, \@ etc. */
1022 PROMPT_DOLLAR = -2,
1023 PROMPT_AT = -3
1026 enum protocol {
1027 PROTO_FILE, /* refers to a local file */
1028 PROTO_POP3, /* is a pop3 server string */
1029 PROTO_MAILDIR, /* refers to a maildir folder */
1030 PROTO_UNKNOWN /* unknown protocol */
1033 enum sendaction {
1034 SEND_MBOX, /* no conversion to perform */
1035 SEND_RFC822, /* no conversion, no From_ line */
1036 SEND_TODISP, /* convert to displayable form */
1037 SEND_TODISP_ALL, /* same, include all MIME parts */
1038 SEND_SHOW, /* convert to 'show' command form */
1039 SEND_TOSRCH, /* convert for IMAP SEARCH */
1040 SEND_TOFILE, /* convert for saving body to a file */
1041 SEND_TOPIPE, /* convert for pipe-content/subc. */
1042 SEND_QUOTE, /* convert for quoting */
1043 SEND_QUOTE_ALL, /* same, include all MIME parts */
1044 SEND_DECRYPT /* decrypt */
1047 #ifdef HAVE_SSL
1048 enum ssl_verify_level {
1049 SSL_VERIFY_IGNORE,
1050 SSL_VERIFY_WARN,
1051 SSL_VERIFY_ASK,
1052 SSL_VERIFY_STRICT
1054 #endif
1056 enum tdflags {
1057 TD_NONE, /* no display conversion */
1058 TD_ISPR = 1<<0, /* use isprint() checks */
1059 TD_ICONV = 1<<1, /* use iconv() */
1060 TD_DELCTRL = 1<<2, /* delete control characters */
1063 * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
1064 * enum sendaction, and may thus NOT clash with their bit range!
1066 _TD_EOF = 1<<14, /* EOF seen, last round! */
1067 _TD_BUFCOPY = 1<<15 /* Buffer may be constant, copy it */
1070 enum user_options {
1071 OPT_NONE,
1072 OPT_DEBUG = 1u<< 0, /* -d / *debug* */
1073 OPT_VERB = 1u<< 1, /* -v / *verbose* */
1074 OPT_VERBVERB = 1u<< 2, /* .. even more verbosity */
1075 OPT_EXISTONLY = 1u<< 3, /* -e */
1076 OPT_HEADERSONLY = 1u<<4, /* -H */
1077 OPT_HEADERLIST = 1u<< 5, /* -L */
1078 OPT_QUICKRUN_MASK = OPT_EXISTONLY | OPT_HEADERSONLY | OPT_HEADERLIST,
1079 OPT_E_FLAG = 1u<< 7, /* -E / *skipemptybody* */
1080 OPT_F_FLAG = 1u<< 8, /* -F */
1081 OPT_N_FLAG = 1u<< 9, /* -N / *header* */
1082 OPT_R_FLAG = 1u<<10, /* -R */
1083 OPT_r_FLAG = 1u<<11, /* -r (plus option_r_arg) */
1084 OPT_t_FLAG = 1u<<12, /* -t */
1085 OPT_u_FLAG = 1u<<13, /* -u / $USER and pw->pw_uid != getuid(2) */
1086 OPT_TILDE_FLAG = 1u<<14, /* -~ */
1087 OPT_BATCH_FLAG = 1u<<15, /* -# */
1089 /* */
1090 OPT_MEMDEBUG = 1<<16, /* *memdebug* */
1092 /* */
1093 OPT_SENDMODE = 1u<<17, /* Usage case forces send mode */
1094 OPT_TTYIN = 1u<<18,
1095 OPT_TTYOUT = 1u<<19,
1096 OPT_INTERACTIVE = 1u<<20,
1097 OPT_UNICODE = 1u<<21, /* We're in an UTF-8 environment */
1098 OPT_ENC_MBSTATE = 1u<<22, /* Multibyte environment with shift states */
1100 /* Some easy-access shortcuts */
1101 OPT_D_V = OPT_DEBUG | OPT_VERB,
1102 OPT_D_VV = OPT_DEBUG | OPT_VERBVERB,
1103 OPT_D_V_VV = OPT_DEBUG | OPT_VERB | OPT_VERBVERB
1106 #define OBSOLETE(X) \
1107 do {\
1108 if (options & OPT_D_V_VV)\
1109 n_err("%s: %s\n", _("Obsoletion warning"), X);\
1110 } while (0)
1111 #define OBSOLETE2(X,Y) \
1112 do {\
1113 if (options & OPT_D_V_VV)\
1114 n_err("%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
1115 } while (0)
1117 enum program_state {
1118 PS_NONE = 0,
1119 PS_STARTED = 1<< 0, /* main.c startup code passed, functional */
1121 PS_LOADING = 1<< 1, /* Loading user resource files, startup */
1122 PS_SOURCING = 1<< 2, /* Sourcing a resource file */
1123 PS_IN_LOAD = PS_LOADING | PS_SOURCING,
1124 PS_PIPING = 1<< 3, /* `source'ing via pipe */
1126 PS_EVAL_ERROR = 1<< 4, /* Last evaluate() command failed */
1128 PS_HOOK_NEWMAIL = 1<< 6,
1129 PS_HOOK = 1<< 7,
1130 PS_HOOK_MASK = PS_HOOK_NEWMAIL | PS_HOOK,
1132 PS_EDIT = 1<< 8, /* Current mailbox not a "system mailbox" */
1133 PS_SETFILE_OPENED = 1<< 9, /* (hack) setfile() opened a new box */
1134 PS_SAW_COMMAND = 1<<10, /* ..after mailbox switch */
1136 PS_DID_PRINT_DOT = 1<<16, /* Current message has been printed */
1138 PS_MSGLIST_SAW_NO = 1<<17, /* Last *LIST saw numerics */
1139 PS_MSGLIST_DIRECT = 1<<18, /* One msg was directly chosen by number */
1140 PS_MSGLIST_MASK = PS_MSGLIST_SAW_NO | PS_MSGLIST_DIRECT,
1142 PS_HEADER_NEEDED_MIME = 1<<20, /* mime_write_tohdr() needed x TODO HACK! */
1144 PS_COLOUR_ACTIVE = 1<<22, /* n_colour_env_create().._gut() cycle */
1146 /* Various first-time-init switches */
1147 PS_ERRORS_NOTED = 1<<24, /* Ring of `errors' content, print msg */
1148 PS_ATTACHMENTS_NOTED = 1<<25, /* Attachment filename quoting noted */
1149 PS_t_FLAG = 1<<26 /* OPT_t_FLAG made persistant */
1152 /* A large enum with all the boolean and value options a.k.a their keys.
1153 * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1154 * ok_[bv]set() and ok_[bv]clear().
1155 * Note: see the comments in accmacvar.c before changing *anything* in here! */
1156 enum okeys {
1157 /* TODO likely temporary hook data, v15 drop */
1158 ok_v_on_compose_enter,
1159 ok_v_on_compose_leave,
1160 ok_v_compose_from,
1161 ok_v_compose_sender,
1162 ok_v_compose_to,
1163 ok_v_compose_cc,
1164 ok_v_compose_bcc,
1165 ok_v_compose_subject,
1167 ok_b_add_file_recipients,
1168 ok_v_agent_shell_lookup,
1169 ok_b_allnet,
1170 ok_b_append,
1171 ok_b_ask,
1172 ok_b_askatend,
1173 ok_b_askattach,
1174 ok_b_askbcc,
1175 ok_b_askcc,
1176 ok_b_asksign,
1177 ok_b_asksub,
1178 ok_b_attachment_ask_content_description,
1179 ok_b_attachment_ask_content_disposition,
1180 ok_b_attachment_ask_content_id,
1181 ok_b_attachment_ask_content_type,
1182 ok_v_attrlist,
1183 ok_v_autobcc,
1184 ok_v_autocc,
1185 ok_b_autocollapse,
1186 ok_b_autoprint,
1187 ok_b_autothread,
1188 ok_v_autosort,
1190 ok_b_bang,
1191 ok_b_batch_exit_on_error,
1192 ok_b_bsdannounce,
1193 ok_b_bsdcompat,
1194 ok_b_bsdflags,
1195 ok_b_bsdheadline,
1196 ok_b_bsdmsgs,
1197 ok_b_bsdorder,
1198 ok_b_bsdset,
1200 ok_v_charset_7bit,
1201 ok_v_charset_8bit,
1202 ok_v_charset_unknown_8bit,
1203 ok_v_cmd,
1204 ok_b_colour_disable,
1205 ok_b_colour_pager,
1206 ok_v_colour_terms,
1207 ok_v_crt,
1208 ok_v_customhdr,
1210 ok_v_DEAD,
1211 ok_v_datefield,
1212 ok_v_datefield_markout_older,
1213 ok_b_debug, /* {special=1} */
1214 ok_b_disposition_notification_send,
1215 ok_b_dot,
1216 ok_b_dotlock_ignore_error,
1218 ok_v_EDITOR,
1219 ok_b_editalong,
1220 ok_b_editheaders,
1221 ok_b_emptybox,
1222 ok_b_emptystart,
1223 ok_v_encoding,
1224 ok_v_escape,
1225 ok_v_expandaddr,
1226 ok_v_expandargv,
1228 ok_v_features, /* {rdonly=1,virtual=_features} */
1229 ok_b_flipr,
1230 ok_v_folder, /* {special=1} */
1231 ok_v_folder_hook,
1232 ok_b_followup_to,
1233 ok_v_followup_to_honour,
1234 ok_b_forward_as_attachment,
1235 ok_v_from,
1236 ok_b_fullnames,
1237 ok_v_fwdheading,
1239 ok_b_header, /* {special=1} */
1240 ok_v_headline,
1241 ok_v_headline_bidi,
1242 ok_v_history_file,
1243 ok_b_history_gabby,
1244 ok_b_history_gabby_persist,
1245 ok_v_history_size,
1246 ok_b_hold,
1247 ok_v_hostname,
1249 ok_b_idna_disable,
1250 ok_b_ignore,
1251 ok_b_ignoreeof,
1252 ok_v_indentprefix,
1254 ok_b_keep,
1255 ok_b_keep_content_length,
1256 ok_b_keepsave,
1258 ok_v_LISTER,
1259 ok_v_line_editor_cursor_right, /* {special=1} */
1260 ok_b_line_editor_disable,
1262 ok_v_MAIL,
1263 ok_v_MBOX,
1264 ok_b_markanswered,
1265 ok_b_mbox_rfc4155,
1266 ok_b_memdebug, /* {special=1} */
1267 ok_b_message_id_disable,
1268 ok_v_message_inject_head,
1269 ok_v_message_inject_tail,
1270 ok_b_metoo,
1271 ok_b_mime_allow_text_controls,
1272 ok_b_mime_alternative_favour_rich,
1273 ok_v_mime_counter_evidence,
1274 ok_v_mimetypes_load_control,
1276 ok_v_NAIL_EXTRA_RC, /* {name=NAIL_EXTRA_RC} */
1277 ok_v_NAIL_HEAD, /* {name=NAIL_HEAD} */
1278 ok_v_NAIL_HISTFILE, /* {name=NAIL_HISTFILE} */
1279 ok_v_NAIL_HISTSIZE, /* {name=NAIL_HISTSIZE} */
1280 ok_v_NAIL_TAIL, /* {name=NAIL_TAIL} */
1281 ok_b_netrc_lookup,
1282 ok_v_newfolders,
1283 ok_v_newmail,
1285 ok_b_outfolder,
1287 ok_v_PAGER,
1288 ok_b_page,
1289 ok_v_password,
1290 ok_b_piperaw,
1291 ok_v_pop3_auth,
1292 ok_b_pop3_bulk_load,
1293 ok_v_pop3_keepalive,
1294 ok_b_pop3_no_apop,
1295 ok_b_pop3_use_starttls,
1296 ok_b_print_alternatives,
1297 ok_v_prompt,
1299 ok_b_quiet,
1300 ok_v_quote,
1301 ok_b_quote_as_attachment,
1302 ok_v_quote_fold,
1304 ok_b_recipients_in_cc,
1305 ok_v_record,
1306 ok_b_record_resent,
1307 ok_b_reply_in_same_charset,
1308 ok_v_reply_strings,
1309 ok_v_replyto,
1310 ok_v_reply_to_honour,
1311 ok_b_rfc822_body_from_, /* {name=rfc822-body-from_} */
1313 ok_v_SHELL,
1314 ok_b_save,
1315 ok_v_screen,
1316 ok_b_searchheaders,
1317 ok_v_sendcharsets,
1318 ok_b_sendcharsets_else_ttycharset,
1319 ok_v_sender,
1320 ok_v_sendmail,
1321 ok_v_sendmail_arguments,
1322 ok_b_sendmail_no_default_arguments,
1323 ok_v_sendmail_progname,
1324 ok_b_sendwait,
1325 ok_b_showlast,
1326 ok_b_showname,
1327 ok_b_showto,
1328 ok_v_Sign,
1329 ok_v_sign,
1330 ok_v_signature,
1331 ok_b_skipemptybody, /* {special=1} */
1332 ok_v_smime_ca_dir,
1333 ok_v_smime_ca_file,
1334 ok_v_smime_cipher,
1335 ok_v_smime_crl_dir,
1336 ok_v_smime_crl_file,
1337 /* smime-encrypt-USER@HOST */
1338 ok_b_smime_force_encryption,
1339 ok_b_smime_no_default_ca,
1340 ok_b_smime_sign,
1341 ok_v_smime_sign_cert,
1342 ok_v_smime_sign_include_certs,
1343 ok_v_smime_sign_message_digest,
1344 ok_v_smtp,
1345 ok_v_smtp_auth,
1346 ok_v_smtp_auth_password,
1347 ok_v_smtp_auth_user,
1348 ok_v_smtp_hostname,
1349 ok_b_smtp_use_starttls,
1350 ok_v_spam_interface,
1351 ok_v_spam_maxsize,
1352 ok_v_spamc_command,
1353 ok_v_spamc_arguments,
1354 ok_v_spamc_user,
1355 ok_v_spamd_socket,
1356 ok_v_spamd_user,
1357 ok_v_spamfilter_ham,
1358 ok_v_spamfilter_noham,
1359 ok_v_spamfilter_nospam,
1360 ok_v_spamfilter_rate,
1361 ok_v_spamfilter_rate_scanscore,
1362 ok_v_spamfilter_spam,
1363 ok_v_ssl_ca_dir,
1364 ok_v_ssl_ca_file,
1365 ok_v_ssl_cert,
1366 ok_v_ssl_cipher_list,
1367 ok_v_ssl_config_file,
1368 ok_v_ssl_crl_dir,
1369 ok_v_ssl_crl_file,
1370 ok_v_ssl_key,
1371 ok_v_ssl_method,
1372 ok_b_ssl_no_default_ca,
1373 ok_v_ssl_protocol,
1374 ok_v_ssl_rand_egd,
1375 ok_v_ssl_rand_file,
1376 ok_v_ssl_verify,
1377 ok_v_stealthmua,
1379 ok_b_term_ca_mode,
1380 ok_v_toplines,
1381 ok_v_ttycharset,
1383 ok_v_user,
1385 ok_v_VISUAL,
1386 ok_b_v15_compat,
1387 ok_b_verbose, /* {special=1} */
1388 ok_v_version, /* {rdonly=1,virtual=VERSION} */
1389 ok_v_version_major, /* {rdonly=1,virtual=VERSION_MAJOR} */
1390 ok_v_version_minor, /* {rdonly=1,virtual=VERSION_MINOR} */
1391 ok_v_version_update, /* {rdonly=1,virtual=VERSION_UPDATE} */
1393 ok_b_writebackedited
1396 /* Locale-independent character classes */
1397 enum {
1398 C_CNTRL = 0000,
1399 C_BLANK = 0001,
1400 C_WHITE = 0002,
1401 C_SPACE = 0004,
1402 C_PUNCT = 0010,
1403 C_OCTAL = 0020,
1404 C_DIGIT = 0040,
1405 C_UPPER = 0100,
1406 C_LOWER = 0200
1409 struct str {
1410 char *s; /* the string's content */
1411 size_t l; /* the stings's length */
1414 struct bidi_info {
1415 struct str bi_start; /* Start of (possibly) bidirectional text */
1416 struct str bi_end; /* End of ... */
1417 size_t bi_pad; /* No of visual columns to reserve for BIDI pad */
1420 #ifdef HAVE_COLOUR
1421 struct n_colour_pen;
1422 #endif
1424 struct url {
1425 char const *url_input; /* Input as given (really) */
1426 enum cproto url_cproto; /* Communication protocol as given */
1427 bool_t url_needs_tls; /* Wether the protocol uses SSL/TLS */
1428 bool_t url_had_user; /* Wether .url_user was part of the URL */
1429 ui16_t url_portno; /* atoi .url_port or default, host endian */
1430 char const *url_port; /* Port (if given) or NULL */
1431 char url_proto[14]; /* Communication protocol as 'xy\0//' */
1432 ui8_t url_proto_len; /* Length of .url_proto ('\0' index) */
1433 ui8_t url_proto_xlen; /* .. if '\0' is replaced with ':' */
1434 struct str url_user; /* User, exactly as given / looked up */
1435 struct str url_user_enc; /* User, urlxenc()oded */
1436 struct str url_pass; /* Pass (urlxdec()oded) or NULL */
1437 struct str url_host; /* Service hostname */
1438 struct str url_path; /* Path suffix or NULL */
1439 /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1440 struct str url_h_p; /* .url_host[:.url_port] */
1441 /* .url_user@.url_host
1442 * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1443 * *hostname*)! (And may later be overwritten according to *from*!) */
1444 struct str url_u_h;
1445 struct str url_u_h_p; /* .url_user@.url_host[:.url_port] */
1446 struct str url_eu_h_p; /* .url_user_enc@.url_host[:.url_port] */
1447 char const *url_p_u_h_p; /* .url_proto://.url_u_h_p */
1448 char const *url_p_eu_h_p; /* .url_proto://.url_eu_h_p */
1449 char const *url_p_eu_h_p_p; /* .url_proto://.url_eu_h_p[/.url_path] */
1452 struct ccred {
1453 enum cproto cc_cproto; /* Communication protocol */
1454 enum authtype cc_authtype; /* Desired authentication */
1455 char const *cc_auth; /* Authentication type as string */
1456 struct str cc_user; /* User (urlxdec()oded) or NULL */
1457 struct str cc_pass; /* Password (urlxdec()oded) or NULL */
1460 #ifdef HAVE_DOTLOCK
1461 struct dotlock_info {
1462 char const *di_file_name; /* Mailbox to lock */
1463 char const *di_lock_name; /* .di_file_name + .lock */
1464 char const *di_hostname; /* ..filled in parent (due resolver delays) */
1465 char const *di_randstr; /* ..ditto, random string */
1466 size_t di_pollmsecs; /* Delay in between locking attempts */
1467 struct stat *di_stb;
1469 #endif
1471 struct mime_handler {
1472 enum mime_handler_flags mh_flags;
1473 struct str mh_msg; /* Message describing this command */
1474 /* XXX union{} the following? */
1475 char const *mh_shell_cmd; /* For MIME_HDL_CMD */
1476 int (*mh_ptf)(void); /* PTF main() for MIME_HDL_PTF */
1479 struct time_current {
1480 time_t tc_time;
1481 struct tm tc_gm;
1482 struct tm tc_local;
1483 char tc_ctime[32];
1486 struct quoteflt {
1487 FILE *qf_os; /* Output stream */
1488 char const *qf_pfix;
1489 ui32_t qf_pfix_len; /* Length of prefix: 0: bypass */
1490 ui32_t qf_qfold_min; /* Simple way: wrote prefix? */
1491 #ifdef HAVE_QUOTE_FOLD
1492 ui32_t qf_qfold_max; /* Otherwise: line lengths */
1493 ui8_t qf_state; /* *quote-fold* state machine */
1494 bool_t qf_brk_isws; /* Breakpoint is at WS */
1495 ui8_t __dummy[2];
1496 ui32_t qf_wscnt; /* Whitespace count */
1497 ui32_t qf_brkl; /* Breakpoint */
1498 ui32_t qf_brkw; /* Visual width, breakpoint */
1499 ui32_t qf_datw; /* Current visual output line width */
1500 struct str qf_dat; /* Current visual output line */
1501 struct str qf_currq; /* Current quote, compressed */
1502 mbstate_t qf_mbps[2];
1503 #endif
1506 #ifdef HAVE_FILTER_HTML_TAGSOUP
1507 struct htmlflt {
1508 FILE *hf_os; /* Output stream */
1509 ui32_t hf_flags;
1510 ui32_t hf_lmax; /* Maximum byte +1 in .hf_line/4 */
1511 ui32_t hf_len; /* Current bytes in .hf_line */
1512 ui32_t hf_last_ws; /* Last whitespace on line (fold purposes) */
1513 ui32_t hf_mboff; /* Last offset for "mbtowc" */
1514 ui32_t hf_mbwidth; /* We count characters not bytes if possible */
1515 char *hf_line; /* Output line buffer - MUST be last field! */
1516 si32_t hf_href_dist; /* Count of lines since last HREF flush */
1517 ui32_t hf_href_no; /* HREF sequence number */
1518 struct htmlflt_href *hf_hrefs;
1519 struct htmlflt_tag const *hf_ign_tag; /* Tag that will end ignore mode */
1520 char *hf_curr; /* Current cursor into .hf_bdat */
1521 char *hf_bmax; /* Maximum byte in .hf_bdat +1 */
1522 char *hf_bdat; /* (Temporary) Tag content data storage */
1524 #endif
1526 struct search_expr {
1527 char const *ss_where; /* ..to search for the expr. (not always used) */
1528 char const *ss_sexpr; /* String search expr.; NULL: use .ss_regex */
1529 #ifdef HAVE_REGEX
1530 regex_t ss_regex;
1531 #endif
1534 struct eval_ctx {
1535 struct str ev_line; /* The terminated data to evaluate */
1536 ui32_t ev_line_size; /* May be used to store line memory size */
1537 bool_t ev_is_recursive; /* Evaluation in evaluation? (collect ~:) */
1538 ui8_t __dummy[3];
1539 bool_t ev_add_history; /* Enter (final) command in history? */
1540 char const *ev_new_content; /* History: reenter line, start with this */
1543 struct termios_state {
1544 struct termios ts_tios;
1545 char *ts_linebuf;
1546 size_t ts_linesize;
1547 bool_t ts_needs_reset;
1550 #define termios_state_reset() \
1551 do {\
1552 if (termios_state.ts_needs_reset) {\
1553 tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
1554 termios_state.ts_needs_reset = FAL0;\
1556 } while (0)
1558 struct sock { /* data associated with a socket */
1559 int s_fd; /* file descriptor */
1560 #ifdef HAVE_SSL
1561 int s_use_ssl; /* SSL is used */
1562 # ifdef HAVE_OPENSSL
1563 void *s_ssl; /* SSL object */
1564 # endif
1565 #endif
1566 char *s_wbuf; /* for buffered writes */
1567 int s_wbufsize; /* allocated size of s_buf */
1568 int s_wbufpos; /* position of first empty data byte */
1569 char *s_rbufptr; /* read pointer to s_rbuf */
1570 int s_rsz; /* size of last read in s_rbuf */
1571 char const *s_desc; /* description of error messages */
1572 void (*s_onclose)(void); /* execute on close */
1573 char s_rbuf[LINESIZE + 1]; /* for buffered reads */
1576 struct sockconn {
1577 struct url sc_url;
1578 struct ccred sc_cred;
1579 struct sock sc_sock;
1582 struct mailbox {
1583 enum {
1584 MB_NONE = 000, /* no reply expected */
1585 MB_COMD = 001, /* command reply expected */
1586 MB_MULT = 002, /* multiline reply expected */
1587 MB_PREAUTH = 004, /* not in authenticated state */
1588 MB_BYE = 010 /* may accept a BYE state */
1589 } mb_active;
1590 FILE *mb_itf; /* temp file with messages, read open */
1591 FILE *mb_otf; /* same, write open */
1592 char *mb_sorted; /* sort method */
1593 enum {
1594 MB_VOID, /* no type (e. g. connection failed) */
1595 MB_FILE, /* local file */
1596 MB_POP3, /* POP3 mailbox */
1597 MB_MAILDIR /* maildir folder */
1598 } mb_type; /* type of mailbox */
1599 enum {
1600 MB_DELE = 01, /* may delete messages in mailbox */
1601 MB_EDIT = 02 /* may edit messages in mailbox */
1602 } mb_perm;
1603 int mb_threaded; /* mailbox has been threaded */
1604 struct sock mb_sock; /* socket structure */
1607 enum needspec {
1608 NEED_UNSPEC, /* unspecified need, don't fetch */
1609 NEED_HEADER, /* need the header of a message */
1610 NEED_BODY /* need header and body of a message */
1613 enum havespec {
1614 HAVE_NOTHING, /* nothing downloaded yet */
1615 HAVE_HEADER = 01, /* header is downloaded */
1616 HAVE_BODY = 02 /* entire message is downloaded */
1619 /* flag bits. Attention: Flags that are used in cache.c may not change */
1620 enum mflag {
1621 MUSED = (1<< 0), /* entry is used, but this bit isn't */
1622 MDELETED = (1<< 1), /* entry has been deleted */
1623 MSAVED = (1<< 2), /* entry has been saved */
1624 MTOUCH = (1<< 3), /* entry has been noticed */
1625 MPRESERVE = (1<< 4), /* keep entry in sys mailbox */
1626 MMARK = (1<< 5), /* message is marked! */
1627 MODIFY = (1<< 6), /* message has been modified */
1628 MNEW = (1<< 7), /* message has never been seen */
1629 MREAD = (1<< 8), /* message has been read sometime. */
1630 MSTATUS = (1<< 9), /* message status has changed */
1631 MBOX = (1<<10), /* Send this to mbox, regardless */
1632 MNOFROM = (1<<11), /* no From line */
1633 MHIDDEN = (1<<12), /* message is hidden to user */
1634 MBOXED = (1<<13), /* message has been sent to mbox */
1635 MNEWEST = (1<<14), /* message is very new (newmail) */
1636 MFLAG = (1<<15), /* message has been flagged recently */
1637 MUNFLAG = (1<<16), /* message has been unflagged */
1638 MFLAGGED = (1<<17), /* message is `flagged' */
1639 MANSWER = (1<<18), /* message has been answered recently */
1640 MUNANSWER = (1<<19), /* message has been unanswered */
1641 MANSWERED = (1<<20), /* message is `answered' */
1642 MDRAFT = (1<<21), /* message has been drafted recently */
1643 MUNDRAFT = (1<<22), /* message has been undrafted */
1644 MDRAFTED = (1<<23), /* message is marked as `draft' */
1645 MOLDMARK = (1<<24), /* messages was marked previously */
1646 MSPAM = (1<<25), /* message is classified as spam */
1647 MSPAMUNSURE = (1<<26) /* message may be spam, but it is unsure */
1649 #define MMNORM (MDELETED | MSAVED | MHIDDEN)
1650 #define MMNDEL (MDELETED | MHIDDEN)
1652 #define visible(mp) (((mp)->m_flag & MMNDEL) == 0)
1654 struct mimepart {
1655 enum mflag m_flag; /* flags */
1656 enum havespec m_have; /* downloaded parts of the part */
1657 #ifdef HAVE_SPAM
1658 ui32_t m_spamscore; /* Spam score as int, 24:8 bits */
1659 #endif
1660 int m_block; /* block number of this part */
1661 size_t m_offset; /* offset in block of part */
1662 size_t m_size; /* Bytes in the part */
1663 size_t m_xsize; /* Bytes in the full part */
1664 long m_lines; /* Lines in the message */
1665 long m_xlines; /* Lines in the full message */
1666 time_t m_time; /* time the message was sent */
1667 char const *m_from; /* message sender */
1668 struct mimepart *m_nextpart; /* next part at same level */
1669 struct mimepart *m_multipart; /* parts of multipart */
1670 struct mimepart *m_parent; /* enclosing multipart part */
1671 char const *m_ct_type; /* content-type */
1672 char const *m_ct_type_plain; /* content-type without specs */
1673 char const *m_ct_type_usr_ovwr; /* Forcefully overwritten one */
1674 enum mimecontent m_mimecontent; /* same in enum */
1675 char const *m_charset; /* charset */
1676 char const *m_ct_enc; /* content-transfer-encoding */
1677 enum mime_enc m_mime_enc; /* same in enum */
1678 char *m_partstring; /* part level string */
1679 char *m_filename; /* attachment filename */
1682 struct message {
1683 enum mflag m_flag; /* flags */
1684 enum havespec m_have; /* downloaded parts of the message */
1685 #ifdef HAVE_SPAM
1686 ui32_t m_spamscore; /* Spam score as int, 24:8 bits */
1687 #endif
1688 int m_block; /* block number of this message */
1689 size_t m_offset; /* offset in block of message */
1690 size_t m_size; /* Bytes in the message */
1691 size_t m_xsize; /* Bytes in the full message */
1692 long m_lines; /* Lines in the message */
1693 long m_xlines; /* Lines in the full message */
1694 time_t m_time; /* time the message was sent */
1695 time_t m_date; /* time in the 'Date' field */
1696 unsigned m_idhash; /* hash on Message-ID for threads */
1697 struct message *m_child; /* first child of this message */
1698 struct message *m_younger; /* younger brother of this message */
1699 struct message *m_elder; /* elder brother of this message */
1700 struct message *m_parent; /* parent of this message */
1701 unsigned m_level; /* thread level of message */
1702 long m_threadpos; /* position in threaded display */
1703 char *m_maildir_file; /* original maildir file of msg */
1704 ui32_t m_maildir_hash; /* hash of file name in maildir sub */
1705 int m_collapsed; /* collapsed thread information */
1708 /* Given a file address, determine the block number it represents */
1709 #define mailx_blockof(off) ((int) ((off) / 4096))
1710 #define mailx_offsetof(off) ((int) ((off) % 4096))
1711 #define mailx_positionof(block, offset) ((off_t)(block) * 4096 + (offset))
1713 /* Argument types */
1714 enum argtype {
1715 ARG_MSGLIST = 0, /* Message list type */
1716 ARG_STRLIST = 1, /* A pure string */
1717 ARG_RAWLIST = 2, /* Shell string list */
1718 ARG_NOLIST = 3, /* Just plain 0 */
1719 ARG_NDMLIST = 4, /* Message list, no defaults */
1720 ARG_ECHOLIST = 5, /* Like raw list, but keep quote chars */
1721 ARG_ARGMASK = 7, /* Mask of the above */
1723 ARG_A = 1u<< 4, /* Needs an active mailbox */
1724 ARG_F = 1u<< 5, /* Is a conditional command */
1725 ARG_H = 1u<< 6, /* Never place in history */
1726 ARG_I = 1u<< 7, /* Interactive command bit */
1727 ARG_M = 1u<< 8, /* Legal from send mode bit */
1728 ARG_P = 1u<< 9, /* Autoprint dot after command */
1729 ARG_R = 1u<<10, /* Cannot be called from collect / recursion */
1730 ARG_T = 1u<<11, /* Is a transparent command */
1731 ARG_V = 1u<<12, /* Places data in temporary_arg_v_store */
1732 ARG_W = 1u<<13, /* Invalid when read only bit */
1733 ARG_O = 1u<<14 /* OBSOLETE()d command */
1736 enum gfield {
1737 GTO = 1<< 0, /* Grab To: line */
1738 GSUBJECT = 1<< 1, /* Likewise, Subject: line */
1739 GCC = 1<< 2, /* And the Cc: line */
1740 GBCC = 1<< 3, /* And also the Bcc: line */
1742 GNL = 1<< 4, /* Print blank line after */
1743 GDEL = 1<< 5, /* Entity removed from list */
1744 GCOMMA = 1<< 6, /* detract() puts in commas */
1745 GUA = 1<< 7, /* User-Agent field */
1746 GMIME = 1<< 8, /* MIME 1.0 fields */
1747 GMSGID = 1<< 9, /* a Message-ID */
1748 GNAMEONLY = 1<<10, /* detract() does NOT use fullnames */
1750 GIDENT = 1<<11, /* From:, Reply-To:, MFT: (user headers) */
1751 GREF = 1<<12, /* References:, In-Reply-To:, (Message-ID:) */
1752 GDATE = 1<<13, /* Date: field */
1753 GFULL = 1<<14, /* Include full names, comments etc. */
1754 GSKIN = 1<<15, /* Skin names */
1755 GEXTRA = 1<<16, /* Extra fields (mostly like GIDENT XXX) */
1756 GFILES = 1<<17, /* Include filename and pipe addresses */
1757 GFULLEXTRA = 1<<18 /* Only with GFULL: GFULL less address */
1759 #define GMASK (GTO | GSUBJECT | GCC | GBCC)
1761 enum header_flags {
1762 HF_NONE = 0,
1763 HF_LIST_REPLY = 1<< 0,
1764 HF_MFT_SENDER = 1<< 1, /* Add ourselves to Mail-Followup-To: */
1765 HF_RECIPIENT_RECORD = 1<<10, /* Save message in file named after rec. */
1766 HF__NEXT_SHIFT = 11
1769 /* Structure used to pass about the current state of a message (header) */
1770 struct n_header_field{
1771 struct n_header_field *hf_next;
1772 ui32_t hf_nl; /* Field-name length */
1773 ui32_t hf_bl; /* Field-body length*/
1774 char hf_dat[VFIELD_SIZE(0)];
1777 struct header {
1778 ui32_t h_flags; /* enum header_flags bits */
1779 ui32_t h_dummy;
1780 struct name *h_to; /* Dynamic "To:" string */
1781 char *h_subject; /* Subject string */
1782 struct name *h_cc; /* Carbon copies string */
1783 struct name *h_bcc; /* Blind carbon copies */
1784 struct name *h_ref; /* References (possibly overridden) */
1785 struct attachment *h_attach; /* MIME attachments */
1786 char *h_charset; /* preferred charset */
1787 struct name *h_from; /* overridden "From:" field */
1788 struct name *h_sender; /* overridden "Sender:" field */
1789 struct name *h_replyto; /* overridden "Reply-To:" field */
1790 struct name *h_message_id; /* overridden "Message-ID:" field */
1791 struct name *h_in_reply_to;/* overridden "In-Reply-To:" field */
1792 struct name *h_mft; /* Mail-Followup-To */
1793 char const *h_list_post; /* Address from List-Post:, for `Lreply' */
1794 struct n_header_field *h_user_headers;
1795 struct n_header_field *h_custom_headers; /* (Cached result) */
1798 /* Handling of namelist nodes used in processing the recipients of mail and
1799 * aliases, inspection of mail-addresses and all that kind of stuff */
1800 enum nameflags {
1801 NAME_NAME_SALLOC = 1<< 0, /* .n_name is doped */
1802 NAME_FULLNAME_SALLOC = 1<< 1, /* .n_fullname is doped */
1803 NAME_SKINNED = 1<< 2, /* Is actually skin()ned */
1804 NAME_IDNA = 1<< 3, /* IDNA was applied */
1806 NAME_ADDRSPEC_CHECKED = 1<< 4, /* Address has been .. and */
1807 NAME_ADDRSPEC_ISFILE = 1<< 5, /* ..is a file path */
1808 NAME_ADDRSPEC_ISPIPE = 1<< 6, /* ..is a command for piping */
1809 NAME_ADDRSPEC_ISFILEORPIPE = NAME_ADDRSPEC_ISFILE | NAME_ADDRSPEC_ISPIPE,
1810 NAME_ADDRSPEC_ISNAME = 1<< 7, /* ..is a valid mail network address */
1811 NAME_ADDRSPEC_ISADDR = 1<< 8, /* ..is a valid mail network address */
1813 NAME_ADDRSPEC_ERR_EMPTY = 1<< 9, /* An empty string (or NULL) */
1814 NAME_ADDRSPEC_ERR_ATSEQ = 1<<10, /* Weird @ sequence */
1815 NAME_ADDRSPEC_ERR_CHAR = 1<<11, /* Invalid character */
1816 NAME_ADDRSPEC_ERR_IDNA = 1<<12, /* IDNA convertion failed */
1817 NAME_ADDRSPEC_INVALID = NAME_ADDRSPEC_ERR_EMPTY |
1818 NAME_ADDRSPEC_ERR_ATSEQ | NAME_ADDRSPEC_ERR_CHAR |
1819 NAME_ADDRSPEC_ERR_IDNA,
1821 /* Error storage (we must fit in 31-bit) */
1822 _NAME_SHIFTWC = 13,
1823 _NAME_MAXWC = 0x3FFFF,
1824 _NAME_MASKWC = _NAME_MAXWC << _NAME_SHIFTWC
1827 /* In the !_ERR_EMPTY case, the failing character can be queried */
1828 #define NAME_ADDRSPEC_ERR_GETWC(F) \
1829 ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
1830 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
1831 do {\
1832 (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
1833 (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
1834 } while (0)
1836 struct name {
1837 struct name *n_flink; /* Forward link in list. */
1838 struct name *n_blink; /* Backward list link */
1839 enum gfield n_type; /* From which list it came */
1840 enum nameflags n_flags; /* enum nameflags */
1841 char *n_name; /* This fella's address */
1842 char *n_fullname; /* Ditto, unless GFULL including comment */
1843 char *n_fullextra; /* GFULL, without address */
1846 struct addrguts {
1847 char const *ag_input; /* Input string as given */
1848 size_t ag_ilen; /* strlen() of input */
1849 size_t ag_iaddr_start; /* Start of *addr-spec* in .ag_input */
1850 size_t ag_iaddr_aend; /* ..and one past its end */
1851 char *ag_skinned; /* Output (alloced if !=.ag_input) */
1852 size_t ag_slen; /* strlen() of .ag_skinned */
1853 size_t ag_sdom_start; /* Start of domain in .ag_skinned, */
1854 enum nameflags ag_n_flags; /* enum nameflags of .ag_skinned */
1857 /* MIME attachments */
1858 enum attach_conv {
1859 AC_DEFAULT, /* _get_lc() -> _iter_*() */
1860 AC_FIX_OUTCS, /* _get_lc() -> "charset=" .a_charset */
1861 AC_FIX_INCS, /* "charset=".a_input_charset (nocnv) */
1862 AC_TMPFILE /* attachment.a_tmpf is converted */
1865 struct attachment {
1866 struct attachment *a_flink; /* Forward link in list. */
1867 struct attachment *a_blink; /* Backward list link */
1868 char const *a_name; /* file name */
1869 char const *a_content_type; /* content type */
1870 char const *a_content_disposition; /* content disposition */
1871 char const *a_content_id; /* content id */
1872 char const *a_content_description; /* content description */
1873 char const *a_input_charset; /* Interpretation depends on .a_conv */
1874 char const *a_charset; /* ... */
1875 FILE *a_tmpf; /* If AC_TMPFILE */
1876 enum attach_conv a_conv; /* User chosen conversion */
1877 int a_msgno; /* message number */
1880 struct sendbundle {
1881 struct header *sb_hp;
1882 struct name *sb_to;
1883 FILE *sb_input;
1884 struct str sb_signer; /* USER@HOST for signing+ */
1885 struct url sb_url;
1886 struct ccred sb_ccred;
1889 /* Structure of the hash table of ignored header fields */
1890 struct ignoretab {
1891 int i_count; /* Number of entries */
1892 struct ignored {
1893 struct ignored *i_link; /* Next ignored field in bucket */
1894 char *i_field; /* This ignored field */
1895 } *i_head[HSHSIZE];
1898 /* For saving the current directory and later returning */
1899 struct cw {
1900 #ifdef HAVE_FCHDIR
1901 int cw_fd;
1902 #else
1903 char cw_wd[PATH_MAX];
1904 #endif
1908 * Global variable declarations
1910 * These become instantiated in main.c.
1913 #undef VL
1914 #ifdef n_MAIN_SOURCE
1915 # ifndef HAVE_AMALGAMATION
1916 # define VL
1917 # else
1918 # define VL static
1919 # endif
1920 #else
1921 # define VL extern
1922 #endif
1924 VL int mb_cur_max; /* Value of MB_CUR_MAX */
1925 VL int realscreenheight; /* The real screen height */
1926 VL int scrnwidth; /* Screen width, or best guess */
1927 VL int scrnheight; /* Screen height/guess (4 header) */
1929 VL char const *homedir; /* Path name of home directory */
1930 VL char const *myname; /* My login name */
1931 VL char const *progname; /* Our name */
1932 VL char const *tempdir; /* The temporary directory */
1934 VL gid_t group_id; /* getgid() and getuid() */
1935 VL uid_t user_id;
1937 VL int exit_status; /* Exit status */
1938 VL ui32_t options; /* Bits of enum user_options */
1939 VL struct name *option_r_arg; /* Argument to -r option */
1940 VL char const **smopts; /* sendmail(1) opts from commline */
1941 VL size_t smopts_count; /* Entries in smopts */
1943 VL ui32_t pstate; /* Bits of enum program_state */
1944 VL size_t noreset; /* String resets suspended (recursive) */
1946 /* XXX stylish sorting */
1947 VL int msgCount; /* Count of messages read in */
1948 VL struct mailbox mb; /* Current mailbox */
1949 VL int image; /* File descriptor for msg image */
1950 VL char mailname[PATH_MAX]; /* Name of current file TODO URL/object*/
1951 VL char displayname[80 - 40]; /* Prettyfied for display TODO URL/obj*/
1952 VL char prevfile[PATH_MAX]; /* Name of previous file TODO URL/obj */
1953 VL char const *account_name; /* Current account name or NULL */
1954 VL off_t mailsize; /* Size of system mailbox */
1955 VL struct message *dot; /* Pointer to current message */
1956 VL struct message *prevdot; /* Previous current message */
1957 VL struct message *message; /* The actual message structure */
1958 VL struct message *threadroot; /* first threaded message */
1960 VL struct ignoretab ignore[2]; /* ignored and retained fields
1961 * 0 is ignore, 1 is retain */
1962 VL struct ignoretab saveignore[2]; /* ignored and retained fields
1963 * on save to folder */
1964 VL struct ignoretab allignore[2]; /* special, ignore all headers */
1965 VL struct ignoretab fwdignore[2]; /* fields to ignore for forwarding */
1967 VL struct time_current time_current; /* time(3); send: mail1() XXXcarrier */
1968 VL struct termios_state termios_state; /* getpassword(); see commands().. */
1970 #ifdef HAVE_SSL
1971 VL enum ssl_verify_level ssl_verify_level; /* SSL verification level */
1972 #endif
1974 #ifdef HAVE_ICONV
1975 VL iconv_t iconvd;
1976 #endif
1978 VL sigjmp_buf srbuf;
1979 VL int interrupts;
1980 VL sighandler_type dflpipe;
1981 VL sighandler_type handlerstacktop;
1982 #define handlerpush(f) (savedtop = handlerstacktop, handlerstacktop = (f))
1983 #define handlerpop() (handlerstacktop = savedtop)
1985 /* TODO Temporary hacks unless the codebase doesn't jump and uses pass-by-value
1986 * TODO carrier structs instead of locals */
1987 VL char *temporary_arg_v_store;
1988 VL void *temporary_localopts_store;
1989 /* TODO temporary storage to overcome which_protocol() mess (for PROTO_FILE) */
1990 VL char const *temporary_protocol_ext;
1992 /* The remaining variables need initialization */
1994 #ifndef HAVE_AMALGAMATION
1995 VL char const month_names[12 + 1][4];
1996 VL char const weekday_names[7 + 1][4];
1998 VL char const uagent[sizeof UAGENT];
2000 VL uc_i const class_char[1 + 0x7F];
2001 #endif
2004 * Finally, let's include the function prototypes XXX embed
2007 #ifndef n_PRIVSEP_SOURCE
2008 # include "nailfuns.h"
2009 #endif
2011 /* s-it-mode */