mutt.h

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