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