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