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