nail.h

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