mutt.h

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