mutt.h

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
   4  * Copyright (C) 2004 g10 Code GmbH
   5  *
   6  * This file is part of mutt-ng, see http://www.muttng.org/.
   7  * It's licensed under the GNU General Public License,
   8  * please see the file GPL in the top level source directory.
   9  */
  10
  11 #ifndef _MUTT_H
  12 #define _MUTT_H
  13
  14 #include "config.h"
  15
  16 #include <stdio.h>
  17 #include <stdlib.h>
  18 #ifdef HAVE_UNISTD_H
  19 # include <unistd.h>            /* needed for SEEK_SET */
  20 #endif
  21 #ifdef HAVE_UNIX_H
  22 # include <unix.h>              /* needed for snprintf on QNX. */
  23 #endif
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <time.h>
  27 #include <limits.h>
  28 #include <stdarg.h>
  29 #include <signal.h>
  30 #ifdef HAVE_WCHAR_H
  31 # include <wchar.h>
  32 #endif
  33 #if defined(HAVE_WCTYPE_H) && defined(HAVE_WC_FUNCS)
  34 # include <wctype.h>
  35 #endif
  36
  37 #ifndef _POSIX_PATH_MAX
  38 #include <posix1_lim.h>
  39 #endif
  40
  41 #include <pwd.h>
  42 #include <grp.h>
  43
  44 #include "rfc822.h"
  45 #include "hash.h"
  46 #include "charset.h"
  47 #include "lib/rx.h"
  48
  49 #ifndef HAVE_WC_FUNCS
  50 # ifdef MB_LEN_MAX
  51 #  undef MB_LEN_MAX
  52 # endif
  53 # define MB_LEN_MAX 16
  54 #endif
  55
  56 # define MUTT_VERSION (VERSION)
  57
  58 /* nifty trick I stole from ELM 2.5alpha. */
  59 #ifdef MAIN_C
  60 #define WHERE
  61 #define INITVAL(x) = x
  62 #else
  63 #define WHERE extern
  64 #define INITVAL(x)
  65 #endif
  66
  67 /* flags for mutt_copy_header() */
  68 #define CH_UPDATE       1       /* update the status and x-status fields? */
  69 #define CH_WEED         (1<<1)  /* weed the headers? */
  70 #define CH_DECODE       (1<<2)  /* do RFC1522 decoding? */
  71 #define CH_XMIT         (1<<3)  /* transmitting this message? */
  72 #define CH_FROM         (1<<4)  /* retain the "From " message separator? */
  73 #define CH_PREFIX       (1<<5)  /* use Prefix string? */
  74 #define CH_NOSTATUS     (1<<6)  /* supress the status and x-status fields */
  75 #define CH_REORDER      (1<<7)  /* Re-order output of headers */
  76 #define CH_NONEWLINE    (1<<8)  /* don't output terminating newline */
  77 #define CH_MIME         (1<<9)  /* ignore MIME fields */
  78 #define CH_UPDATE_LEN   (1<<10) /* update Lines: and Content-Length: */
  79 #define CH_TXTPLAIN     (1<<11) /* generate text/plain MIME headers */
  80 #define CH_NOLEN        (1<<12) /* don't write Content-Length: and Lines: */
  81 #define CH_WEED_DELIVERED (1<<13)       /* weed eventual Delivered-To headers */
  82 #define CH_FORCE_FROM   (1<<14) /* give CH_FROM precedence over CH_WEED? */
  83 #define CH_NOQFROM      (1<<15) /* give CH_FROM precedence over CH_WEED? */
  84 #define CH_UPDATE_IRT   (1<<16) /* update In-Reply-To: */
  85 #define CH_UPDATE_REFS  (1<<17) /* update References: */
  86
  87 /* flags for mutt_enter_string() */
  88 #define  M_ALIAS   1            /* do alias "completion" by calling up the alias-menu */
  89 #define  M_FILE    (1<<1)       /* do file completion */
  90 #define  M_EFILE   (1<<2)       /* do file completion, plus incoming folders */
  91 #define  M_CMD     (1<<3)       /* do completion on previous word */
  92 #define  M_PASS    (1<<4)       /* password mode (no echo) */
  93 #define  M_CLEAR   (1<<5)       /* clear input if printable character is pressed */
  94 #define  M_COMMAND (1<<6)       /* do command completion */
  95 #define  M_PATTERN (1<<7)       /* pattern mode - only used for history classes */
  96 #define  M_LASTFOLDER (1<<8)    /* last-folder mode - hack hack hack */
  97
  98 /* flags for mutt_get_token() */
  99 #define M_TOKEN_EQUAL           1       /* treat '=' as a special */
 100 #define M_TOKEN_CONDENSE        (1<<1)  /* ^(char) to control chars (macros) */
 101 #define M_TOKEN_SPACE           (1<<2)  /* don't treat whitespace as a term */
 102 #define M_TOKEN_QUOTE           (1<<3)  /* don't interpret quotes */
 103 #define M_TOKEN_PATTERN         (1<<4)  /* !)|~ are terms (for patterns) */
 104 #define M_TOKEN_COMMENT         (1<<5)  /* don't reap comments */
 105 #define M_TOKEN_SEMICOLON       (1<<6)  /* don't treat ; as special */
 106
 107 /* flags for km_dokey() */
 108 #define M_KM_UNBUFFERED 1       /* don't read from the key buffer */
 109
 110 typedef struct {
 111   char *data;                   /* pointer to data */
 112   char *dptr;                   /* current read/write position */
 113   size_t dsize;                 /* length of data */
 114   int destroy;                  /* destroy `data' when done? */
 115 } BUFFER;
 116
 117 typedef struct {
 118   int ch;                       /* raw key pressed */
 119   int op;                       /* function op */
 120 } event_t;
 121
 122 /* flags for _mutt_system() */
 123 #define M_DETACH_PROCESS        1       /* detach subprocess from group */
 124
 125 /* flags for mutt_FormatString() */
 126 typedef enum {
 127   M_FORMAT_FORCESUBJ = (1 << 0),        /* print the subject even if unchanged */
 128   M_FORMAT_TREE = (1 << 1),     /* draw the thread tree */
 129   M_FORMAT_MAKEPRINT = (1 << 2),        /* make sure that all chars are printable */
 130   M_FORMAT_OPTIONAL = (1 << 3),
 131   M_FORMAT_STAT_FILE = (1 << 4),        /* used by mutt_attach_fmt */
 132   M_FORMAT_ARROWCURSOR = (1 << 5),      /* reserve space for arrow_cursor */
 133   M_FORMAT_INDEX = (1 << 6)     /* this is a main index entry */
 134 } format_flag;
 135
 136 /* types for mutt_add_hook() */
 137 #define M_FOLDERHOOK    1
 138 #define M_MBOXHOOK      (1<<1)
 139 #define M_SENDHOOK      (1<<2)
 140 #define M_FCCHOOK       (1<<3)
 141 #define M_SAVEHOOK      (1<<4)
 142 #define M_CHARSETHOOK   (1<<5)
 143 #define M_ICONVHOOK     (1<<6)
 144 #define M_MESSAGEHOOK   (1<<7)
 145 #define M_CRYPTHOOK     (1<<8)
 146 #define M_ACCOUNTHOOK   (1<<9)
 147 #define M_REPLYHOOK     (1<<10)
 148 #define M_SEND2HOOK     (1<<11)
 149
 150 #ifdef USE_COMPRESSED
 151 #define M_OPENHOOK      (1<<12)
 152 #define M_APPENDHOOK    (1<<13)
 153 #define M_CLOSEHOOK     (1<<14)
 154 #endif
 155
 156 /* tree characters for linearize_tree and print_enriched_string */
 157 #define M_TREE_LLCORNER         1
 158 #define M_TREE_ULCORNER         2
 159 #define M_TREE_LTEE             3
 160 #define M_TREE_HLINE            4
 161 #define M_TREE_VLINE            5
 162 #define M_TREE_SPACE            6
 163 #define M_TREE_RARROW           7
 164 #define M_TREE_STAR             8
 165 #define M_TREE_HIDDEN           9
 166 #define M_TREE_EQUALS           10
 167 #define M_TREE_TTEE             11
 168 #define M_TREE_BTEE             12
 169 #define M_TREE_MISSING          13
 170 #define M_TREE_MAX              14
 171
 172 #define M_THREAD_COLLAPSE       (1<<0)
 173 #define M_THREAD_UNCOLLAPSE     (1<<1)
 174 #define M_THREAD_GET_HIDDEN     (1<<2)
 175 #define M_THREAD_UNREAD         (1<<3)
 176 #define M_THREAD_NEXT_UNREAD    (1<<4)
 177
 178 enum {
 179   /* modes for mutt_view_attachment() */
 180   M_REGULAR = 1,
 181   M_MAILCAP,
 182   M_AS_TEXT,
 183
 184   /* action codes used by mutt_set_flag() and mutt_pattern_function() */
 185   M_ALL,
 186   M_NONE,
 187   M_NEW,
 188   M_OLD,
 189   M_REPLIED,
 190   M_READ,
 191   M_UNREAD,
 192   M_DELETE,
 193   M_UNDELETE,
 194   M_DELETED,
 195   M_APPENDED,
 196   M_PURGED,
 197   M_FLAG,
 198   M_TAG,
 199   M_UNTAG,
 200   M_LIMIT,
 201   M_EXPIRED,
 202   M_SUPERSEDED,
 203   M_REALNAME,
 204
 205   /* actions for mutt_pattern_comp/mutt_pattern_exec */
 206   M_AND,
 207   M_OR,
 208   M_TO,
 209   M_CC,
 210   M_COLLAPSED,
 211   M_SUBJECT,
 212   M_FROM,
 213   M_DATE,
 214   M_DATE_RECEIVED,
 215   M_DUPLICATED,
 216   M_UNREFERENCED,
 217   M_ID,
 218   M_BODY,
 219   M_HEADER,
 220   M_HORMEL,
 221   M_WHOLE_MSG,
 222   M_SENDER,
 223   M_MESSAGE,
 224   M_SCORE,
 225   M_SIZE,
 226   M_REFERENCE,
 227   M_RECIPIENT,
 228   M_LIST,
 229   M_PERSONAL_RECIP,
 230   M_PERSONAL_FROM,
 231   M_ADDRESS,
 232   M_CRYPT_SIGN,
 233   M_CRYPT_VERIFIED,
 234   M_CRYPT_ENCRYPT,
 235   M_PGP_KEY,
 236   M_XLABEL,
 237 #ifdef USE_NNTP
 238   M_NEWSGROUPS,
 239 #endif
 240
 241   /* Options for Mailcap lookup */
 242   M_EDIT,
 243   M_COMPOSE,
 244   M_PRINT,
 245   M_AUTOVIEW,
 246
 247   /* options for socket code */
 248   M_NEW_SOCKET,
 249 #ifdef USE_SSL
 250   M_NEW_SSL_SOCKET,
 251 #endif
 252
 253   /* Options for mutt_save_attachment */
 254   M_SAVE_APPEND,
 255   M_SAVE_OVERWRITE
 256 };
 257
 258 /* possible arguments to set_quadoption() */
 259 enum {
 260   M_NO,
 261   M_YES,
 262   M_ASKNO,
 263   M_ASKYES
 264 };
 265
 266 /* quad-option vars */
 267 enum {
 268   OPT_ABORT,
 269   OPT_BOUNCE,
 270   OPT_COPY,
 271   OPT_DELETE,
 272   OPT_FORWEDIT,
 273   OPT_INCLUDE,
 274 #ifdef USE_IMAP
 275   OPT_IMAPRECONNECT,
 276 #endif
 277   OPT_MFUPTO,
 278   OPT_MIMEFWD,
 279   OPT_MIMEFWDREST,
 280   OPT_MOVE,
 281   OPT_PGPMIMEAUTO,              /* ask to revert to PGP/MIME when inline fails */
 282 #ifdef USE_POP
 283   OPT_POPDELETE,
 284   OPT_POPRECONNECT,
 285 #endif
 286   OPT_POSTPONE,
 287   OPT_PRINT,
 288   OPT_QUIT,
 289   OPT_REPLYTO,
 290   OPT_RECALL,
 291 #if defined(USE_SSL) || defined(USE_GNUTLS)
 292   OPT_SSLSTARTTLS,
 293 #endif
 294   OPT_SUBJECT,
 295   OPT_VERIFYSIG,                /* verify PGP signatures */
 296   OPT_LISTREPLY,
 297 #ifdef USE_NNTP
 298   OPT_TOMODERATED,
 299   OPT_NNTPRECONNECT,
 300   OPT_CATCHUP,
 301   OPT_FOLLOWUPTOPOSTER,
 302 #endif                          /* USE_NNTP */
 303
 304   /* THIS MUST BE THE LAST VALUE. */
 305   OPT_MAX
 306 };
 307
 308 /* flags to ci_send_message() */
 309 #define SENDREPLY       (1<<0)
 310 #define SENDGROUPREPLY  (1<<1)
 311 #define SENDLISTREPLY   (1<<2)
 312 #define SENDFORWARD     (1<<3)
 313 #define SENDPOSTPONED   (1<<4)
 314 #define SENDBATCH       (1<<5)
 315 #define SENDMAILX       (1<<6)
 316 #define SENDKEY         (1<<7)
 317 #define SENDRESEND      (1<<8)
 318 #define SENDNEWS        (1<<9)
 319
 320 /* flags to _mutt_select_file() */
 321 #define M_SEL_BUFFY     (1<<0)
 322 #define M_SEL_MULTI     (1<<1)
 323 #define M_SEL_FOLDER    (1<<2)
 324
 325 /* flags for parse_spam_list */
 326 #define M_SPAM          1
 327 #define M_NOSPAM        2
 328
 329 /* boolean vars */
 330 enum {
 331   OPTALLOW8BIT,
 332   OPTALLOWANSI,
 333   OPTARROWCURSOR,
 334   OPTASCIICHARS,
 335   OPTASKBCC,
 336   OPTASKCC,
 337   OPTASKFOLLOWUP,
 338   OPTASKXCOMMENTTO,
 339   OPTATTACHSPLIT,
 340   OPTAUTOEDIT,
 341   OPTAUTOTAG,
 342   OPTBEEP,
 343   OPTBEEPNEW,
 344   OPTBOUNCEDELIVERED,
 345   OPTBRAILLEFRIENDLY,
 346   OPTCHECKNEW,
 347   OPTCOLLAPSEUNREAD,
 348   OPTCONFIRMAPPEND,
 349   OPTCONFIRMCREATE,
 350   OPTDELETEUNTAG,
 351   OPTDIGESTCOLLAPSE,
 352   OPTDUPTHREADS,
 353   OPTEDITHDRS,
 354   OPTENCODEFROM,
 355   OPTENVFROM,
 356   OPTFASTREPLY,
 357   OPTFCCATTACH,
 358   OPTFCCCLEAR,
 359   OPTFOLLOWUPTO,
 360   OPTFORCEBUFFYCHECK,
 361   OPTFORCENAME,
 362   OPTFORWDECODE,
 363   OPTFORWQUOTE,
 364 #if USE_HCACHE
 365   OPTHCACHEVERIFY,
 366 #if HAVE_QDBM
 367   OPTHCACHECOMPRESS,
 368 #endif /* HAVE_QDBM */
 369 #endif
 370   OPTHDRS,
 371   OPTHEADER,
 372   OPTHELP,
 373   OPTHIDDENHOST,
 374   OPTHIDELIMITED,
 375   OPTHIDEMISSING,
 376   OPTHIDETHREADSUBJECT,
 377   OPTHIDETOPLIMITED,
 378   OPTHIDETOPMISSING,
 379   OPTIGNORELISTREPLYTO,
 380 #ifdef USE_IMAP
 381   OPTIMAPLSUB,
 382   OPTIMAPPASSIVE,
 383   OPTIMAPPEEK,
 384   OPTIMAPSERVERNOISE,
 385 # if defined(USE_SSL) || defined(USE_GNUTLS)
 386   OPTIMAPFORCESSL,
 387 # endif
 388 #endif
 389 #if defined(USE_SSL) || defined(USE_GNUTLS)
 390 # ifndef USE_GNUTLS
 391   OPTSSLV2,
 392 # endif
 393   OPTSSLV3,
 394   OPTTLSV1,
 395 # ifndef USE_GNUTLS
 396   OPTSSLSYSTEMCERTS,
 397 # endif
 398 #endif
 399   OPTIMPLICITAUTOVIEW,
 400   OPTINCLUDEONLYFIRST,
 401   OPTKEEPFLAGGED,
 402   OPTMAILCAPSANITIZE,
 403   OPTMAILDIRTRASH,
 404   OPTMARKERS,
 405   OPTMARKOLD,
 406   OPTMBOXPANE,
 407   OPTMENUSCROLL,                /* scroll menu instead of implicit next-page */
 408   OPTMENUMOVEOFF,
 409   OPTMETAKEY,                   /* interpret ALT-x as ESC-x */
 410   OPTMETOO,
 411   OPTMHPURGE,
 412   OPTMIMEFORWDECODE,
 413 #ifdef USE_NNTP
 414   OPTMIMESUBJECT,               /* encode subject line with RFC2047 */
 415 #endif
 416   OPTNARROWTREE,
 417   OPTPAGERSTOP,
 418   OPTPIPEDECODE,
 419   OPTPIPESPLIT,
 420 #ifdef USE_POP
 421   OPTPOPAUTHTRYALL,
 422   OPTPOPLAST,
 423 #endif
 424   OPTPRINTDECODE,
 425   OPTPRINTSPLIT,
 426   OPTPROMPTAFTER,
 427   OPTQUOTEEMPTY,
 428   OPTQUOTEQUOTED,
 429   OPTREADONLY,
 430   OPTREPLYSELF,
 431   OPTRESOLVE,
 432   OPTREVALIAS,
 433   OPTREVNAME,
 434   OPTREVREAL,
 435   OPTRFC2047PARAMS,
 436   OPTSAVEADDRESS,
 437   OPTSAVEEMPTY,
 438   OPTSAVENAME,
 439   OPTSCORE,
 440   OPTSIGDASHES,
 441   OPTSIGONTOP,
 442   OPTSORTRE,
 443   OPTSPAMSEP,
 444   OPTSTATUSONTOP,
 445   OPTSTRICTMAILTO,
 446   OPTSTRICTMIME,
 447   OPTSTRICTTHREADS,
 448   OPTSTRIPWAS,
 449   OPTSTUFFQUOTED,
 450   OPTSUSPEND,
 451   OPTTEXTFLOWED,
 452   OPTTHOROUGHSRC,
 453   OPTTHREADRECEIVED,
 454   OPTTILDE,
 455   OPTUNCOLLAPSEJUMP,
 456   OPTUSE8BITMIME,
 457   OPTUSEDOMAIN,
 458   OPTUSEFROM,
 459   OPTUSEGPGAGENT,
 460 #ifdef HAVE_LIBIDN
 461   OPTUSEIDN,
 462 #endif
 463 #ifdef HAVE_GETADDRINFO
 464   OPTUSEIPV6,
 465 #endif
 466   OPTWAITKEY,
 467   OPTWEED,
 468   OPTWRAP,
 469   OPTWRAPSEARCH,
 470   OPTWRITEBCC,                  /* write out a bcc header? */
 471   OPTXMAILER,
 472   OPTXTERMSETTITLES,
 473
 474   OPTCRYPTUSEGPGME,
 475
 476   /* PGP options */
 477
 478   OPTCRYPTAUTOSIGN,
 479   OPTCRYPTAUTOENCRYPT,
 480   OPTCRYPTAUTOPGP,
 481   OPTCRYPTAUTOSMIME,
 482   OPTCRYPTREPLYENCRYPT,
 483   OPTCRYPTREPLYSIGN,
 484   OPTCRYPTREPLYSIGNENCRYPTED,
 485   OPTCRYPTTIMESTAMP,
 486   OPTSMIMEISDEFAULT,
 487   OPTASKCERTLABEL,
 488   OPTSDEFAULTDECRYPTKEY,
 489   OPTPGPIGNORESUB,
 490   OPTPGPCHECKEXIT,
 491   OPTPGPLONGIDS,
 492   OPTPGPAUTODEC,
 493 #if 0
 494   OPTPGPENCRYPTSELF,
 495 #endif
 496   OPTPGPRETAINABLESIG,
 497   OPTPGPSTRICTENC,
 498   OPTFORWDECRYPT,
 499   OPTPGPSHOWUNUSABLE,
 500   OPTPGPAUTOINLINE,
 501   OPTPGPREPLYINLINE,
 502
 503   /* news options */
 504
 505 #ifdef USE_NNTP
 506   OPTSHOWNEWNEWS,
 507   OPTSHOWONLYUNREAD,
 508   OPTSAVEUNSUB,
 509   OPTLOADDESC,
 510   OPTXCOMMENTTO,
 511 #endif                          /* USE_NNTP */
 512
 513   /* pseudo options */
 514
 515   OPTAUXSORT,                   /* (pseudo) using auxillary sort function */
 516   OPTFORCEREFRESH,              /* (pseudo) refresh even during macros */
 517   OPTLOCALES,                   /* (pseudo) set if user has valid locale definition */
 518   OPTNOCURSES,                  /* (pseudo) when sending in batch mode */
 519   OPTNEEDREDRAW,                /* (pseudo) to notify caller of a submenu */
 520   OPTSEARCHREVERSE,             /* (pseudo) used by ci_search_command */
 521   OPTMSGERR,                    /* (pseudo) used by mutt_error/mutt_message */
 522   OPTSEARCHINVALID,             /* (pseudo) used to invalidate the search pat */
 523   OPTSIGNALSBLOCKED,            /* (pseudo) using by mutt_block_signals () */
 524   OPTSYSSIGNALSBLOCKED,         /* (pseudo) using by mutt_block_signals_system () */
 525   OPTNEEDRESORT,                /* (pseudo) used to force a re-sort */
 526   OPTRESORTINIT,                /* (pseudo) used to force the next resort to be from scratch */
 527   OPTVIEWATTACH,                /* (pseudo) signals that we are viewing attachments */
 528   OPTFORCEREDRAWINDEX,          /* (pseudo) used to force a redraw in the main index */
 529   OPTFORCEREDRAWPAGER,          /* (pseudo) used to force a redraw in the pager */
 530   OPTSORTSUBTHREADS,            /* (pseudo) used when $sort_aux changes */
 531   OPTNEEDRESCORE,               /* (pseudo) set when the `score' command is used */
 532   OPTATTACHMSG,                 /* (pseudo) used by attach-message */
 533   OPTHIDEREAD,                  /* (pseudo) whether or not hide read messages */
 534   OPTKEEPQUIET,                 /* (pseudo) shut up the message and refresh
 535                                  *          functions while we are executing an
 536                                  *          external program.
 537                                  */
 538   OPTMENUCALLER,                /* (pseudo) tell menu to give caller a take */
 539   OPTREDRAWTREE,                /* (pseudo) redraw the thread tree */
 540   OPTPGPCHECKTRUST,             /* (pseudo) used by pgp_select_key () */
 541   OPTDONTHANDLEPGPKEYS,         /* (pseudo) used to extract PGP keys */
 542   OPTUNBUFFEREDINPUT,           /* (pseudo) don't use key buffer */
 543
 544 #ifdef USE_NNTP
 545   OPTNEWS,                      /* (pseudo) used to change reader mode */
 546   OPTNEWSSEND,                  /* (pseudo) used to change behavior when posting */
 547   OPTNEWSCACHE,                 /* (pseudo) used to indicate if news cache exist */
 548 #endif
 549   OPTSHORTENHIERARCHY,          /* set when to shorten "hierarchies" in the sidebar */
 550   OPTSIDEBARNEWMAILONLY,
 551   OPTMAX
 552 };
 553
 554 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
 555 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
 556 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
 557 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
 558 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
 559
 560 #define set_option(x) mutt_bit_set(Options,x)
 561 #define unset_option(x) mutt_bit_unset(Options,x)
 562 #define toggle_option(x) mutt_bit_toggle(Options,x)
 563 #define option(x) mutt_bit_isset(Options,x)
 564
 565 /* Exit values used in send_msg() */
 566 #define S_ERR 127
 567 #define S_BKG 126
 568
 569 typedef struct list_t {
 570   char *data;
 571   struct list_t *next;
 572 } LIST;
 573
 574 typedef struct spam_list_t {
 575   rx_t *rx;
 576   int nmatch;
 577   char *template;
 578   struct spam_list_t *next;
 579 } SPAM_LIST;
 580
 581
 582 #define mutt_new_list() safe_calloc (1, sizeof (LIST))
 583 #define mutt_new_spam_list() safe_calloc (1, sizeof (SPAM_LIST))
 584 void mutt_free_list (LIST **);
 585 void mutt_free_spam_list (SPAM_LIST **);
 586 LIST *mutt_copy_list (LIST *);
 587 int mutt_matches_ignore (const char *, LIST *);
 588
 589 /* add an element to a list */
 590 LIST *mutt_add_list (LIST*, const char*);
 591 LIST *mutt_add_list_n (LIST*, const void*, size_t len);
 592
 593 void mutt_init (int, LIST *);
 594
 595 typedef struct alias {
 596   struct alias *self;           /* XXX - ugly hack */
 597   char *name;
 598   ADDRESS *addr;
 599   struct alias *next;
 600   short tagged;
 601   short del;
 602   short num;
 603 } ALIAS;
 604
 605 typedef struct envelope {
 606   ADDRESS *return_path;
 607   ADDRESS *from;
 608   ADDRESS *to;
 609   ADDRESS *cc;
 610   ADDRESS *bcc;
 611   ADDRESS *sender;
 612   ADDRESS *reply_to;
 613   ADDRESS *mail_followup_to;
 614   char *list_post;              /* this stores a mailto URL, or nothing */
 615   char *subject;
 616   char *real_subj;              /* offset of the real subject */
 617   char *message_id;
 618   char *supersedes;
 619   char *date;
 620   char *x_label;
 621   char *organization;
 622 #ifdef USE_NNTP
 623   char *newsgroups;
 624   char *xref;
 625   char *followup_to;
 626   char *x_comment_to;
 627 #endif
 628   BUFFER *spam;
 629   LIST *references;             /* message references (in reverse order) */
 630   LIST *in_reply_to;            /* in-reply-to header content */
 631   LIST *userhdrs;               /* user defined headers */
 632   unsigned int irt_changed:1;   /* In-Reply-To changed to link/break threads */
 633   unsigned int refs_changed:1;  /* References changed to break thread */
 634 } ENVELOPE;
 635
 636 typedef struct parameter {
 637   char *attribute;
 638   char *value;
 639   struct parameter *next;
 640 } PARAMETER;
 641
 642 /* Information that helps in determing the Content-* of an attachment */
 643 typedef struct content {
 644   long hibin;                   /* 8-bit characters */
 645   long lobin;                   /* unprintable 7-bit chars (eg., control chars) */
 646   long crlf;                    /* '\r' and '\n' characters */
 647   long ascii;                   /* number of ascii chars */
 648   long linemax;                 /* length of the longest line in the file */
 649   unsigned int space:1;         /* whitespace at the end of lines? */
 650   unsigned int binary:1;        /* long lines, or CR not in CRLF pair */
 651   unsigned int from:1;          /* has a line beginning with "From "? */
 652   unsigned int dot:1;           /* has a line consisting of a single dot? */
 653   unsigned int cr:1;            /* has CR, even when in a CRLF pair */
 654 } CONTENT;
 655
 656 typedef struct body {
 657   char *xtype;                  /* content-type if x-unknown */
 658   char *subtype;                /* content-type subtype */
 659   PARAMETER *parameter;         /* parameters of the content-type */
 660   char *description;            /* content-description */
 661   char *form_name;              /* Content-Disposition form-data name param */
 662   long hdr_offset;              /* offset in stream where the headers begin.
 663                                  * this info is used when invoking metamail,
 664                                  * where we need to send the headers of the
 665                                  * attachment
 666                                  */
 667   long offset;                  /* offset where the actual data begins */
 668   long length;                  /* length (in bytes) of attachment */
 669   char *filename;               /* when sending a message, this is the file
 670                                  * to which this structure refers
 671                                  */
 672   char *d_filename;             /* filename to be used for the
 673                                  * content-disposition header.
 674                                  * If NULL, filename is used
 675                                  * instead.
 676                                  */
 677   char *file_charset;           /* charset of attached file */
 678   CONTENT *content;             /* structure used to store detailed info about
 679                                  * the content of the attachment.  this is used
 680                                  * to determine what content-transfer-encoding
 681                                  * is required when sending mail.
 682                                  */
 683   struct body *next;            /* next attachment in the list */
 684   struct body *parts;           /* parts of a multipart or message/rfc822 */
 685   struct header *hdr;           /* header information for message/rfc822 */
 686
 687   struct attachptr *aptr;       /* Menu information, used in recvattach.c */
 688
 689   time_t stamp;                 /* time stamp of last
 690                                  * encoding update.
 691                                  */
 692
 693   unsigned int type:4;          /* content-type primary type */
 694   unsigned int encoding:3;      /* content-transfer-encoding */
 695   unsigned int disposition:2;   /* content-disposition */
 696   unsigned int use_disp:1;      /* Content-Disposition uses filename= ? */
 697   unsigned int unlink:1;        /* flag to indicate the the file named by
 698                                  * "filename" should be unlink()ed before
 699                                  * free()ing this structure
 700                                  */
 701   unsigned int tagged:1;
 702   unsigned int deleted:1;       /* attachment marked for deletion */
 703
 704   unsigned int noconv:1;        /* don't do character set conversion */
 705   unsigned int force_charset:1;
 706   /* send mode: don't adjust the character
 707    * set when in send-mode.
 708    */
 709   unsigned int is_signed_data:1;        /* A lot of MUAs don't indicate
 710                                            S/MIME signed-data correctly,
 711                                            e.g. they use foo.p7m even for
 712                                            the name of signed data.  This
 713                                            flag is used to keep track of
 714                                            the actual message type.  It
 715                                            gets set during the verification
 716                                            (which is done if the encryption
 717                                            try failed) and check by the
 718                                            function to figure the type of
 719                                            the message. */
 720
 721   unsigned int goodsig:1;       /* good cryptographic signature */
 722   unsigned int warnsig:1;       /* maybe good signature */
 723   unsigned int badsig:1;        /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
 724
 725   unsigned int collapsed:1;     /* used by recvattach */
 726
 727 } BODY;
 728
 729 typedef struct header {
 730   unsigned int security:11;     /* bit 0-6: flags, bit 7,8: application.
 731                                    see: crypt.h pgplib.h, smime.h */
 732
 733   unsigned int mime:1;          /* has a Mime-Version header? */
 734   unsigned int flagged:1;       /* marked important? */
 735   unsigned int tagged:1;
 736   unsigned int appended:1;      /* has been saved */
 737   unsigned int purged:1;        /* bypassing the trash folder */
 738   unsigned int deleted:1;
 739   unsigned int changed:1;
 740   unsigned int attach_del:1;    /* has an attachment marked for deletion */
 741   unsigned int old:1;
 742   unsigned int read:1;
 743   unsigned int expired:1;       /* already expired? */
 744   unsigned int superseded:1;    /* got superseded? */
 745   unsigned int replied:1;
 746   unsigned int subject_changed:1;       /* used for threading */
 747   unsigned int threaded:1;      /* used for threading */
 748   unsigned int display_subject:1;       /* used for threading */
 749   unsigned int recip_valid:1;   /* is_recipient is valid */
 750   unsigned int active:1;        /* message is not to be removed */
 751   unsigned int trash:1;         /* message is marked as trashed on disk.
 752                                  * This flag is used by the maildir_trash
 753                                  * option.
 754                                  */
 755
 756   /* timezone of the sender of this message */
 757   unsigned int zhours:5;
 758   unsigned int zminutes:6;
 759   unsigned int zoccident:1;
 760
 761   /* bits used for caching when searching */
 762   unsigned int searched:1;
 763   unsigned int matched:1;
 764
 765   /* the following are used to support collapsing threads  */
 766   unsigned int collapsed:1;     /* is this message part of a collapsed thread? */
 767   unsigned int limited:1;       /* is this message in a limited view?  */
 768   size_t num_hidden;            /* number of hidden messages in this view */
 769
 770   short recipient;              /* user_is_recipient()'s return value, cached */
 771
 772   int pair;                     /* color-pair to use when displaying in the index */
 773
 774   time_t date_sent;             /* time when the message was sent (UTC) */
 775   time_t received;              /* time when the message was placed in the mailbox */
 776   long offset;                  /* where in the stream does this message begin? */
 777   int lines;                    /* how many lines in the body of this message? */
 778   int index;                    /* the absolute (unsorted) message number */
 779   int msgno;                    /* number displayed to the user */
 780   int virtual;                  /* virtual message number */
 781   int score;
 782   ENVELOPE *env;                /* envelope information */
 783   BODY *content;                /* list of MIME parts */
 784   char *path;
 785 #ifdef USE_NNTP
 786   int article_num;
 787 #endif
 788
 789   char *tree;                   /* character string to print thread tree */
 790   struct thread *thread;
 791
 792 #ifdef MIXMASTER
 793   LIST *chain;
 794 #endif
 795
 796 #ifdef USE_POP
 797   int refno;                    /* message number on server */
 798 #endif
 799
 800 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 801   void *data;                   /* driver-specific data */
 802 #endif
 803
 804   char *maildir_flags;          /* unknown maildir flags */
 805 } HEADER;
 806
 807 typedef struct thread {
 808   unsigned int fake_thread:1;
 809   unsigned int duplicate_thread:1;
 810   unsigned int sort_children:1;
 811   unsigned int check_subject:1;
 812   unsigned int visible:1;
 813   unsigned int deep:1;
 814   unsigned int subtree_visible:2;
 815   unsigned int next_subtree_visible:1;
 816   struct thread *parent;
 817   struct thread *child;
 818   struct thread *next;
 819   struct thread *prev;
 820   HEADER *message;
 821   HEADER *sort_key;
 822 } THREAD;
 823
 824
 825 /* flag to mutt_pattern_comp() */
 826 #define M_FULL_MSG      1       /* enable body and header matching */
 827
 828 typedef enum {
 829   M_MATCH_FULL_ADDRESS = 1
 830 } pattern_exec_flag;
 831
 832 typedef struct pattern_t {
 833   short op;
 834   short not;
 835   short alladdr;
 836   int min;
 837   int max;
 838   struct pattern_t *next;
 839   struct pattern_t *child;      /* arguments to logical op */
 840   regex_t *rx;
 841 } pattern_t;
 842
 843 typedef struct {
 844   char *path;
 845   FILE *fp;
 846   time_t mtime;
 847   time_t mtime_cur;             /* used with maildir folders */
 848   off_t size;
 849   off_t vsize;
 850   char *pattern;                /* limit pattern string */
 851   pattern_t *limit_pattern;     /* compiled limit pattern */
 852   HEADER **hdrs;
 853   HEADER *last_tag;             /* last tagged msg. used to link threads */
 854   THREAD *tree;                 /* top of thread tree */
 855   HASH *id_hash;                /* hash table by msg id */
 856   HASH *subj_hash;              /* hash table by subject */
 857   HASH *thread_hash;            /* hash table for threading */
 858   int *v2r;                     /* mapping from virtual to real msgno */
 859   int hdrmax;                   /* number of pointers in hdrs */
 860   int msgcount;                 /* number of messages in the mailbox */
 861   int vcount;                   /* the number of virtual messages */
 862   int tagged;                   /* how many messages are tagged? */
 863   int new;                      /* how many new messages? */
 864   int unread;                   /* how many unread messages? */
 865   int deleted;                  /* how many deleted messages */
 866   int appended;                 /* how many saved messages? */
 867   int flagged;                  /* how many flagged messages */
 868   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 869 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 870   void *data;                   /* driver specific data */
 871 #endif                          /* USE_IMAP */
 872
 873   short magic;                  /* mailbox type */
 874
 875 #ifdef USE_COMPRESSED
 876   void *compressinfo;           /* compressed mbox module private data */
 877   char *realpath;               /* path to compressed mailbox */
 878 #endif                          /* USE_COMPRESSED */
 879
 880   unsigned int locked:1;        /* is the mailbox locked? */
 881   unsigned int changed:1;       /* mailbox has been modified */
 882   unsigned int readonly:1;      /* don't allow changes to the mailbox */
 883   unsigned int dontwrite:1;     /* dont write the mailbox on close */
 884   unsigned int append:1;        /* mailbox is opened in append mode */
 885   unsigned int quiet:1;         /* inhibit status messages? */
 886   unsigned int collapsed:1;     /* are all threads collapsed? */
 887   unsigned int closing:1;       /* mailbox is being closed */
 888   unsigned int counting:1;      /* do we just want to cound? */
 889 } CONTEXT;
 890
 891 typedef struct attachptr {
 892   BODY *content;
 893   int parent_type;
 894   char *tree;
 895   int level;
 896   int num;
 897   unsigned int unowned:1;       /* don't unlink on detach */
 898 } ATTACHPTR;
 899
 900 typedef struct {
 901   FILE *fpin;
 902   FILE *fpout;
 903   char *prefix;
 904   int flags;
 905 } STATE;
 906
 907 /* used by enter.c */
 908
 909 typedef struct {
 910   wchar_t *wbuf;
 911   size_t wbuflen;
 912   size_t lastchar;
 913   size_t curpos;
 914   size_t begin;
 915   int tabs;
 916 } ENTER_STATE;
 917
 918 /* flags for the STATE struct */
 919 #define M_DISPLAY       (1<<0)  /* output is displayed to the user */
 920 #define M_VERIFY        (1<<1)  /* perform signature verification */
 921 #define M_PENDINGPREFIX (1<<2)  /* prefix to write, but character must follow */
 922 #define M_WEED          (1<<3)  /* weed headers even when not in display mode */
 923 #define M_CHARCONV      (1<<4)  /* Do character set conversions */
 924 #define M_PRINTING      (1<<5)  /* are we printing? - M_DISPLAY "light" */
 925 #define M_REPLYING      (1<<6)  /* are we replying? */
 926 #define M_FIRSTDONE     (1<<7)  /* the first attachment has been done */
 927
 928 #define state_set_prefix(s) ((s)->flags |= M_PENDINGPREFIX)
 929 #define state_reset_prefix(s) ((s)->flags &= ~M_PENDINGPREFIX)
 930 #define state_puts(x,y) fputs(x,(y)->fpout)
 931 #define state_putc(x,y) fputc(x,(y)->fpout)
 932
 933 void state_mark_attach (STATE *);
 934 void state_attach_puts (const char *, STATE *);
 935 void state_prefix_putc (char, STATE *);
 936 int state_printf (STATE *, const char *, ...);
 937
 938 #include "ascii.h"
 939 #include "protos.h"
 940 #include "lib.h"
 941 #include "globals.h"
 942
 943 #endif /* !_MUTT_H */