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