mutt.h

   1 /*
   2  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
   3  * Copyright (C) 2004 g10 Code GmbH
   4  *
   5  *     This program is free software; you can redistribute it and/or modify
   6  *     it under the terms of the GNU General Public License as published by
   7  *     the Free Software Foundation; either version 2 of the License, or
   8  *     (at your option) any later version.
   9  *
  10  *     This program is distributed in the hope that it will be useful,
  11  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *     GNU General Public License for more details.
  14  *
  15  *     You should have received a copy of the GNU General Public License
  16  *     along with this program; if not, write to the Free Software
  17  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  18  */
  19
  20 #ifndef MUTT_H
  21 #define MUTT_H
  22
  23 #include "config.h"
  24
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #ifdef HAVE_UNISTD_H
  28 # include <unistd.h> /* needed for SEEK_SET */
  29 #endif
  30 #ifdef HAVE_UNIX_H
  31 # include <unix.h>   /* needed for snprintf on QNX. */
  32 #endif
  33 #include <sys/types.h>
  34 #include <sys/stat.h>
  35 #include <time.h>
  36 #include <limits.h>
  37 #include <stdarg.h>
  38 #include <signal.h>
  39 #ifdef HAVE_WCHAR_H
  40 # include <wchar.h>
  41 #endif
  42 #if defined(HAVE_WCTYPE_H) && defined(HAVE_WC_FUNCS)
  43 # include <wctype.h>
  44 #endif
  45
  46 #ifndef _POSIX_PATH_MAX
  47 #include <posix1_lim.h>
  48 #endif
  49
  50 #include <pwd.h>
  51 #include <grp.h>
  52
  53 #include "rfc822.h"
  54 #include "hash.h"
  55 #include "charset.h"
  56
  57 #ifndef HAVE_WC_FUNCS
  58 # ifdef MB_LEN_MAX
  59 #  undef MB_LEN_MAX
  60 # endif
  61 # define MB_LEN_MAX 16
  62 #endif
  63
  64 #ifdef SUBVERSION
  65 # define MUTT_VERSION (VERSION SUBVERSION)
  66 #else
  67 # define MUTT_VERSION (VERSION)
  68 #endif
  69
  70 /* nifty trick I stole from ELM 2.5alpha. */
  71 #ifdef MAIN_C
  72 #define WHERE
  73 #define INITVAL(x) = x
  74 #else
  75 #define WHERE extern
  76 #define INITVAL(x)
  77 #endif
  78
  79 #include "mutt_regex.h"
  80
  81 /* flags for mutt_copy_header() */
  82 #define CH_UPDATE       1      /* update the status and x-status fields? */
  83 #define CH_WEED         (1<<1) /* weed the headers? */
  84 #define CH_DECODE       (1<<2) /* do RFC1522 decoding? */
  85 #define CH_XMIT         (1<<3) /* transmitting this message? */
  86 #define CH_FROM         (1<<4) /* retain the "From " message separator? */
  87 #define CH_PREFIX       (1<<5) /* use Prefix string? */
  88 #define CH_NOSTATUS     (1<<6) /* supress the status and x-status fields */
  89 #define CH_REORDER      (1<<7) /* Re-order output of headers */
  90 #define CH_NONEWLINE    (1<<8) /* don't output terminating newline */
  91 #define CH_MIME         (1<<9) /* ignore MIME fields */
  92 #define CH_UPDATE_LEN   (1<<10) /* update Lines: and Content-Length: */
  93 #define CH_TXTPLAIN     (1<<11) /* generate text/plain MIME headers */
  94 #define CH_NOLEN        (1<<12) /* don't write Content-Length: and Lines: */
  95 #define CH_WEED_DELIVERED (1<<13) /* weed eventual Delivered-To headers */
  96 #define CH_FORCE_FROM   (1<<14) /* give CH_FROM precedence over CH_WEED? */
  97 #define CH_NOQFROM      (1<<15) /* give CH_FROM precedence over CH_WEED? */
  98 #define CH_UPDATE_IRT   (1<<16) /* update In-Reply-To: */
  99 #define CH_UPDATE_REFS  (1<<17) /* update References: */
 100
 101 /* flags for mutt_enter_string() */
 102 #define  M_ALIAS   1      /* do alias "completion" by calling up the alias-menu */
 103 #define  M_FILE    (1<<1) /* do file completion */
 104 #define  M_EFILE   (1<<2) /* do file completion, plus incoming folders */
 105 #define  M_CMD     (1<<3) /* do completion on previous word */
 106 #define  M_PASS    (1<<4) /* password mode (no echo) */
 107 #define  M_CLEAR   (1<<5) /* clear input if printable character is pressed */
 108 #define  M_COMMAND (1<<6) /* do command completion */
 109 #define  M_PATTERN (1<<7) /* pattern mode - only used for history classes */
 110 #define  M_LASTFOLDER (1<<8) /* last-folder mode - hack hack hack */
 111
 112 /* flags for mutt_get_token() */
 113 #define M_TOKEN_EQUAL           1       /* treat '=' as a special */
 114 #define M_TOKEN_CONDENSE        (1<<1)  /* ^(char) to control chars (macros) */
 115 #define M_TOKEN_SPACE           (1<<2)  /* don't treat whitespace as a term */
 116 #define M_TOKEN_QUOTE           (1<<3)  /* don't interpret quotes */
 117 #define M_TOKEN_PATTERN         (1<<4)  /* !)|~ are terms (for patterns) */
 118 #define M_TOKEN_COMMENT         (1<<5)  /* don't reap comments */
 119 #define M_TOKEN_SEMICOLON       (1<<6)  /* don't treat ; as special */
 120
 121 /* flags for km_dokey() */
 122 #define M_KM_UNBUFFERED 1 /* don't read from the key buffer */
 123
 124 typedef struct
 125 {
 126   char *data;   /* pointer to data */
 127   char *dptr;   /* current read/write position */
 128   size_t dsize; /* length of data */
 129   int destroy;  /* destroy `data' when done? */
 130 } BUFFER;
 131
 132 typedef struct
 133 {
 134   int ch; /* raw key pressed */
 135   int op; /* function op */
 136 } event_t;
 137
 138 /* flags for _mutt_system() */
 139 #define M_DETACH_PROCESS        1       /* detach subprocess from group */
 140
 141 /* flags for mutt_FormatString() */
 142 typedef enum
 143 {
 144   M_FORMAT_FORCESUBJ    = (1<<0), /* print the subject even if unchanged */
 145   M_FORMAT_TREE         = (1<<1), /* draw the thread tree */
 146   M_FORMAT_MAKEPRINT    = (1<<2), /* make sure that all chars are printable */
 147   M_FORMAT_OPTIONAL     = (1<<3),
 148   M_FORMAT_STAT_FILE    = (1<<4), /* used by mutt_attach_fmt */
 149   M_FORMAT_ARROWCURSOR  = (1<<5), /* reserve space for arrow_cursor */
 150   M_FORMAT_INDEX        = (1<<6)  /* this is a main index entry */
 151 } format_flag;
 152
 153 /* types for mutt_add_hook() */
 154 #define M_FOLDERHOOK    1
 155 #define M_MBOXHOOK      (1<<1)
 156 #define M_SENDHOOK      (1<<2)
 157 #define M_FCCHOOK       (1<<3)
 158 #define M_SAVEHOOK      (1<<4)
 159 #define M_CHARSETHOOK   (1<<5)
 160 #define M_ICONVHOOK     (1<<6)
 161 #define M_MESSAGEHOOK   (1<<7)
 162 #define M_CRYPTHOOK     (1<<8)
 163 #define M_ACCOUNTHOOK   (1<<9)
 164 #define M_REPLYHOOK     (1<<10)
 165 #define M_SEND2HOOK     (1<<11)
 166
 167 #ifdef USE_COMPRESSED
 168 #define M_OPENHOOK      (1<<12)
 169 #define M_APPENDHOOK    (1<<13)
 170 #define M_CLOSEHOOK     (1<<14)
 171 #endif
 172
 173 /* tree characters for linearize_tree and print_enriched_string */
 174 #define M_TREE_LLCORNER         1
 175 #define M_TREE_ULCORNER         2
 176 #define M_TREE_LTEE             3
 177 #define M_TREE_HLINE            4
 178 #define M_TREE_VLINE            5
 179 #define M_TREE_SPACE            6
 180 #define M_TREE_RARROW           7
 181 #define M_TREE_STAR             8
 182 #define M_TREE_HIDDEN           9
 183 #define M_TREE_EQUALS           10
 184 #define M_TREE_TTEE             11
 185 #define M_TREE_BTEE             12
 186 #define M_TREE_MISSING          13
 187 #define M_TREE_MAX              14
 188
 189 #define M_THREAD_COLLAPSE       (1<<0)
 190 #define M_THREAD_UNCOLLAPSE     (1<<1)
 191 #define M_THREAD_GET_HIDDEN     (1<<2)
 192 #define M_THREAD_UNREAD         (1<<3)
 193 #define M_THREAD_NEXT_UNREAD    (1<<4)
 194
 195 enum
 196 {
 197   /* modes for mutt_view_attachment() */
 198   M_REGULAR = 1,
 199   M_MAILCAP,
 200   M_AS_TEXT,
 201
 202   /* action codes used by mutt_set_flag() and mutt_pattern_function() */
 203   M_ALL,
 204   M_NONE,
 205   M_NEW,
 206   M_OLD,
 207   M_REPLIED,
 208   M_READ,
 209   M_UNREAD,
 210   M_DELETE,
 211   M_UNDELETE,
 212   M_DELETED,
 213   M_APPENDED,
 214   M_PURGED,
 215   M_FLAG,
 216   M_TAG,
 217   M_UNTAG,
 218   M_LIMIT,
 219   M_EXPIRED,
 220   M_SUPERSEDED,
 221   M_REALNAME,
 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   OPTSTRICTMIME,
 461   OPTSTRICTTHREADS,
 462   OPTSTUFFQUOTED,
 463   OPTSUSPEND,
 464   OPTTEXTFLOWED,
 465   OPTTHOROUGHSRC,
 466   OPTTHREADRECEIVED,
 467   OPTTILDE,
 468   OPTUNCOLLAPSEJUMP,
 469   OPTUSE8BITMIME,
 470   OPTUSEDOMAIN,
 471   OPTUSEFROM,
 472   OPTUSEGPGAGENT,
 473 #ifdef HAVE_LIBIDN
 474   OPTUSEIDN,
 475 #endif
 476 #ifdef HAVE_GETADDRINFO
 477   OPTUSEIPV6,
 478 #endif
 479   OPTWAITKEY,
 480   OPTWEED,
 481   OPTWRAP,
 482   OPTWRAPSEARCH,
 483   OPTWRITEBCC,          /* write out a bcc header? */
 484   OPTXMAILER,
 485   OPTXTERMSETTITLES,
 486
 487   OPTCRYPTUSEGPGME,
 488
 489   /* PGP options */
 490
 491   OPTCRYPTAUTOSIGN,
 492   OPTCRYPTAUTOENCRYPT,
 493   OPTCRYPTAUTOPGP,
 494   OPTCRYPTAUTOSMIME,
 495   OPTCRYPTREPLYENCRYPT,
 496   OPTCRYPTREPLYSIGN,
 497   OPTCRYPTREPLYSIGNENCRYPTED,
 498   OPTCRYPTTIMESTAMP,
 499   OPTSMIMEISDEFAULT,
 500   OPTASKCERTLABEL,
 501   OPTSDEFAULTDECRYPTKEY,
 502   OPTPGPIGNORESUB,
 503   OPTPGPCHECKEXIT,
 504   OPTPGPLONGIDS,
 505   OPTPGPAUTODEC,
 506 #if 0
 507   OPTPGPENCRYPTSELF,
 508 #endif
 509   OPTPGPRETAINABLESIG,
 510   OPTPGPSTRICTENC,
 511   OPTFORWDECRYPT,
 512   OPTPGPSHOWUNUSABLE,
 513   OPTPGPAUTOINLINE,
 514   OPTPGPREPLYINLINE,
 515
 516   /* news options */
 517
 518 #ifdef USE_NNTP
 519   OPTSHOWNEWNEWS,
 520   OPTSHOWONLYUNREAD,
 521   OPTSAVEUNSUB,
 522   OPTLOADDESC,
 523   OPTXCOMMENTTO,
 524 #endif /* USE_NNTP */
 525
 526   /* pseudo options */
 527
 528   OPTAUXSORT,           /* (pseudo) using auxillary sort function */
 529   OPTFORCEREFRESH,      /* (pseudo) refresh even during macros */
 530   OPTLOCALES,           /* (pseudo) set if user has valid locale definition */
 531   OPTNOCURSES,          /* (pseudo) when sending in batch mode */
 532   OPTNEEDREDRAW,        /* (pseudo) to notify caller of a submenu */
 533   OPTSEARCHREVERSE,     /* (pseudo) used by ci_search_command */
 534   OPTMSGERR,            /* (pseudo) used by mutt_error/mutt_message */
 535   OPTSEARCHINVALID,     /* (pseudo) used to invalidate the search pat */
 536   OPTSIGNALSBLOCKED,    /* (pseudo) using by mutt_block_signals () */
 537   OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
 538   OPTNEEDRESORT,        /* (pseudo) used to force a re-sort */
 539   OPTRESORTINIT,        /* (pseudo) used to force the next resort to be from scratch */
 540   OPTVIEWATTACH,        /* (pseudo) signals that we are viewing attachments */
 541   OPTFORCEREDRAWINDEX,  /* (pseudo) used to force a redraw in the main index */
 542   OPTFORCEREDRAWPAGER,  /* (pseudo) used to force a redraw in the pager */
 543   OPTSORTSUBTHREADS,    /* (pseudo) used when $sort_aux changes */
 544   OPTNEEDRESCORE,       /* (pseudo) set when the `score' command is used */
 545   OPTATTACHMSG,         /* (pseudo) used by attach-message */
 546   OPTHIDEREAD,          /* (pseudo) whether or not hide read messages */
 547   OPTKEEPQUIET,         /* (pseudo) shut up the message and refresh
 548                          *          functions while we are executing an
 549                          *          external program.
 550                          */
 551   OPTMENUCALLER,        /* (pseudo) tell menu to give caller a take */
 552   OPTREDRAWTREE,        /* (pseudo) redraw the thread tree */
 553   OPTPGPCHECKTRUST,     /* (pseudo) used by pgp_select_key () */
 554   OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
 555   OPTUNBUFFEREDINPUT,   /* (pseudo) don't use key buffer */
 556
 557 #ifdef USE_NNTP
 558   OPTNEWS,              /* (pseudo) used to change reader mode */
 559   OPTNEWSSEND,          /* (pseudo) used to change behavior when posting */
 560   OPTNEWSCACHE,         /* (pseudo) used to indicate if news cache exist */
 561 #endif
 562   OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
 563
 564   OPTMAX
 565 };
 566
 567 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
 568 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
 569 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
 570 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
 571 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
 572
 573 #define set_option(x) mutt_bit_set(Options,x)
 574 #define unset_option(x) mutt_bit_unset(Options,x)
 575 #define toggle_option(x) mutt_bit_toggle(Options,x)
 576 #define option(x) mutt_bit_isset(Options,x)
 577
 578 /* Exit values used in send_msg() */
 579 #define S_ERR 127
 580 #define S_BKG 126
 581
 582 typedef struct list_t
 583 {
 584   char *data;
 585   struct list_t *next;
 586 } LIST;
 587
 588 typedef struct rx_list_t
 589 {
 590   REGEXP *rx;
 591   struct rx_list_t *next;
 592 } RX_LIST;
 593
 594 typedef struct spam_list_t
 595 {
 596   REGEXP *rx;
 597   int     nmatch;
 598   char   *template;
 599   struct spam_list_t *next;
 600 } SPAM_LIST;
 601
 602
 603 #define mutt_new_list() safe_calloc (1, sizeof (LIST))
 604 #define mutt_new_spam_list() safe_calloc (1, sizeof (SPAM_LIST))
 605 #define mutt_new_rx_list() safe_calloc (1, sizeof (RX_LIST))
 606 void mutt_free_list (LIST **);
 607 void mutt_free_rx_list (RX_LIST **);
 608 void mutt_free_spam_list (SPAM_LIST **);
 609 LIST *mutt_copy_list (LIST *);
 610 int mutt_matches_ignore (const char *, LIST *);
 611 /* add an element to a list */
 612 LIST *mutt_add_list (LIST *, const char *);
 613
 614 void mutt_init (int, LIST *);
 615
 616 typedef struct alias
 617 {
 618   struct alias *self;           /* XXX - ugly hack */
 619   char *name;
 620   ADDRESS *addr;
 621   struct alias *next;
 622   short tagged;
 623   short del;
 624   short num;
 625 } ALIAS;
 626
 627 typedef struct envelope
 628 {
 629   ADDRESS *return_path;
 630   ADDRESS *from;
 631   ADDRESS *to;
 632   ADDRESS *cc;
 633   ADDRESS *bcc;
 634   ADDRESS *sender;
 635   ADDRESS *reply_to;
 636   ADDRESS *mail_followup_to;
 637   char *list_post;              /* this stores a mailto URL, or nothing */
 638   char *subject;
 639   char *real_subj;              /* offset of the real subject */
 640   char *message_id;
 641   char *supersedes;
 642   char *date;
 643   char *x_label;
 644   char *organization;
 645 #ifdef USE_NNTP
 646   char *newsgroups;
 647   char *xref;
 648   char *followup_to;
 649   char *x_comment_to;
 650 #endif
 651   BUFFER *spam;
 652   LIST *references;             /* message references (in reverse order) */
 653   LIST *in_reply_to;            /* in-reply-to header content */
 654   LIST *userhdrs;               /* user defined headers */
 655 } ENVELOPE;
 656
 657 typedef struct parameter
 658 {
 659   char *attribute;
 660   char *value;
 661   struct parameter *next;
 662 } PARAMETER;
 663
 664 /* Information that helps in determing the Content-* of an attachment */
 665 typedef struct content
 666 {
 667   long hibin;              /* 8-bit characters */
 668   long lobin;              /* unprintable 7-bit chars (eg., control chars) */
 669   long crlf;               /* '\r' and '\n' characters */
 670   long ascii;              /* number of ascii chars */
 671   long linemax;            /* length of the longest line in the file */
 672   unsigned int space : 1;  /* whitespace at the end of lines? */
 673   unsigned int binary : 1; /* long lines, or CR not in CRLF pair */
 674   unsigned int from : 1;   /* has a line beginning with "From "? */
 675   unsigned int dot : 1;    /* has a line consisting of a single dot? */
 676   unsigned int cr : 1;     /* has CR, even when in a CRLF pair */
 677 } CONTENT;
 678
 679 typedef struct body
 680 {
 681   char *xtype;                  /* content-type if x-unknown */
 682   char *subtype;                /* content-type subtype */
 683   PARAMETER *parameter;         /* parameters of the content-type */
 684   char *description;            /* content-description */
 685   char *form_name;              /* Content-Disposition form-data name param */
 686   long hdr_offset;              /* offset in stream where the headers begin.
 687                                  * this info is used when invoking metamail,
 688                                  * where we need to send the headers of the
 689                                  * attachment
 690                                  */
 691   long offset;                  /* offset where the actual data begins */
 692   long length;                  /* length (in bytes) of attachment */
 693   char *filename;               /* when sending a message, this is the file
 694                                  * to which this structure refers
 695                                  */
 696   char *d_filename;             /* filename to be used for the
 697                                  * content-disposition header.
 698                                  * If NULL, filename is used
 699                                  * instead.
 700                                  */
 701   char *file_charset;           /* charset of attached file */
 702   CONTENT *content;             /* structure used to store detailed info about
 703                                  * the content of the attachment.  this is used
 704                                  * to determine what content-transfer-encoding
 705                                  * is required when sending mail.
 706                                  */
 707   struct body *next;            /* next attachment in the list */
 708   struct body *parts;           /* parts of a multipart or message/rfc822 */
 709   struct header *hdr;           /* header information for message/rfc822 */
 710
 711   struct attachptr *aptr;       /* Menu information, used in recvattach.c */
 712
 713   time_t stamp;                 /* time stamp of last
 714                                  * encoding update.
 715                                  */
 716
 717   unsigned int type : 4;        /* content-type primary type */
 718   unsigned int encoding : 3;    /* content-transfer-encoding */
 719   unsigned int disposition : 2; /* content-disposition */
 720   unsigned int use_disp : 1;    /* Content-Disposition uses filename= ? */
 721   unsigned int unlink : 1;      /* flag to indicate the the file named by
 722                                  * "filename" should be unlink()ed before
 723                                  * free()ing this structure
 724                                  */
 725   unsigned int tagged : 1;
 726   unsigned int deleted : 1;     /* attachment marked for deletion */
 727
 728   unsigned int noconv : 1;      /* don't do character set conversion */
 729   unsigned int force_charset : 1;
 730                                 /* send mode: don't adjust the character
 731                                  * set when in send-mode.
 732                                  */
 733   unsigned int is_signed_data : 1; /* A lot of MUAs don't indicate
 734                                       S/MIME signed-data correctly,
 735                                       e.g. they use foo.p7m even for
 736                                       the name of signed data.  This
 737                                       flag is used to keep track of
 738                                       the actual message type.  It
 739                                       gets set during the verification
 740                                       (which is done if the encryption
 741                                       try failed) and check by the
 742                                       function to figure the type of
 743                                       the message. */
 744
 745   unsigned int goodsig : 1;     /* good cryptographic signature */
 746   unsigned int warnsig : 1;     /* maybe good signature */
 747   unsigned int badsig : 1;      /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
 748
 749   unsigned int collapsed : 1;   /* used by recvattach */
 750
 751 } BODY;
 752
 753 typedef struct header
 754 {
 755   unsigned int security : 11;  /* bit 0-6: flags, bit 7,8: application.
 756                                  see: crypt.h pgplib.h, smime.h */
 757
 758   unsigned int mime : 1;                /* has a Mime-Version header? */
 759   unsigned int flagged : 1;             /* marked important? */
 760   unsigned int tagged : 1;
 761   unsigned int appended : 1; /* has been saved */
 762   unsigned int purged : 1;   /* bypassing the trash folder */
 763   unsigned int deleted : 1;
 764   unsigned int changed : 1;
 765   unsigned int attach_del : 1;          /* has an attachment marked for deletion */
 766   unsigned int old : 1;
 767   unsigned int read : 1;
 768   unsigned int expired : 1;             /* already expired? */
 769   unsigned int superseded : 1;          /* got superseded? */
 770   unsigned int replied : 1;
 771   unsigned int subject_changed : 1;     /* used for threading */
 772   unsigned int threaded : 1;            /* used for threading */
 773   unsigned int display_subject : 1;     /* used for threading */
 774   unsigned int irt_changed : 1; /* In-Reply-To changed to link/break threads */
 775   unsigned int refs_changed : 1; /* References changed to break thread */
 776   unsigned int recip_valid : 1;         /* is_recipient is valid */
 777   unsigned int active : 1;              /* message is not to be removed */
 778   unsigned int trash : 1;               /* message is marked as trashed on disk.
 779                                          * This flag is used by the maildir_trash
 780                                          * option.
 781                                          */
 782
 783   /* timezone of the sender of this message */
 784   unsigned int zhours : 5;
 785   unsigned int zminutes : 6;
 786   unsigned int zoccident : 1;
 787
 788   /* bits used for caching when searching */
 789   unsigned int searched : 1;
 790   unsigned int matched : 1;
 791
 792   /* the following are used to support collapsing threads  */
 793   unsigned int collapsed : 1;   /* is this message part of a collapsed thread? */
 794   unsigned int limited : 1;     /* is this message in a limited view?  */
 795   size_t num_hidden;            /* number of hidden messages in this view */
 796
 797   short recipient;              /* user_is_recipient()'s return value, cached */
 798
 799   int pair;                     /* color-pair to use when displaying in the index */
 800
 801   time_t date_sent;             /* time when the message was sent (UTC) */
 802   time_t received;              /* time when the message was placed in the mailbox */
 803   long offset;                  /* where in the stream does this message begin? */
 804   int lines;                    /* how many lines in the body of this message? */
 805   int index;                    /* the absolute (unsorted) message number */
 806   int msgno;                    /* number displayed to the user */
 807   int virtual;                  /* virtual message number */
 808   int score;
 809   ENVELOPE *env;                /* envelope information */
 810   BODY *content;                /* list of MIME parts */
 811   char *path;
 812 #ifdef USE_NNTP
 813   int article_num;
 814 #endif
 815
 816   char *tree;                   /* character string to print thread tree */
 817   struct thread *thread;
 818
 819 #ifdef IMAP_EDIT_THREADS
 820   ENVELOPE *new_env;    /* envelope information for rethreading */
 821 #endif
 822
 823 #ifdef MIXMASTER
 824   LIST *chain;
 825 #endif
 826
 827 #ifdef USE_POP
 828   int refno;                    /* message number on server */
 829 #endif
 830
 831 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 832   void *data;                   /* driver-specific data */
 833 #endif
 834
 835   char *maildir_flags;          /* unknown maildir flags */
 836 } HEADER;
 837
 838 typedef struct thread
 839 {
 840   unsigned int fake_thread : 1;
 841   unsigned int duplicate_thread : 1;
 842   unsigned int sort_children : 1;
 843   unsigned int check_subject : 1;
 844   unsigned int visible : 1;
 845   unsigned int deep : 1;
 846   unsigned int subtree_visible : 2;
 847   unsigned int next_subtree_visible : 1;
 848   struct thread *parent;
 849   struct thread *child;
 850   struct thread *next;
 851   struct thread *prev;
 852   HEADER *message;
 853   HEADER *sort_key;
 854 } THREAD;
 855
 856
 857 /* flag to mutt_pattern_comp() */
 858 #define M_FULL_MSG      1       /* enable body and header matching */
 859
 860 typedef enum {
 861   M_MATCH_FULL_ADDRESS = 1
 862 } pattern_exec_flag;
 863
 864 typedef struct pattern_t
 865 {
 866   short op;
 867   short not;
 868   short alladdr;
 869   int min;
 870   int max;
 871   struct pattern_t *next;
 872   struct pattern_t *child;              /* arguments to logical op */
 873   regex_t *rx;
 874 } pattern_t;
 875
 876 typedef struct
 877 {
 878   char *path;
 879   FILE *fp;
 880   time_t mtime;
 881   time_t mtime_cur;             /* used with maildir folders */
 882   off_t size;
 883   off_t vsize;
 884   char *pattern;                /* limit pattern string */
 885   pattern_t *limit_pattern;     /* compiled limit pattern */
 886   HEADER **hdrs;
 887   HEADER *last_tag;             /* last tagged msg. used to link threads */
 888   THREAD *tree;                 /* top of thread tree */
 889   HASH *id_hash;                /* hash table by msg id */
 890   HASH *subj_hash;              /* hash table by subject */
 891   HASH *thread_hash;            /* hash table for threading */
 892   int *v2r;                     /* mapping from virtual to real msgno */
 893   int hdrmax;                   /* number of pointers in hdrs */
 894   int msgcount;                 /* number of messages in the mailbox */
 895   int vcount;                   /* the number of virtual messages */
 896   int tagged;                   /* how many messages are tagged? */
 897   int new;                      /* how many new messages? */
 898   int unread;                   /* how many unread messages? */
 899   int deleted;                  /* how many deleted messages */
 900   int appended;                 /* how many saved messages? */
 901   int flagged;                  /* how many flagged messages */
 902   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 903 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 904   void *data;                   /* driver specific data */
 905 #endif /* USE_IMAP */
 906
 907   short magic;                  /* mailbox type */
 908
 909 #ifdef USE_COMPRESSED
 910   void *compressinfo;           /* compressed mbox module private data */
 911   char *realpath;               /* path to compressed mailbox */
 912 #endif /* USE_COMPRESSED */
 913
 914   unsigned int locked : 1;      /* is the mailbox locked? */
 915   unsigned int changed : 1;     /* mailbox has been modified */
 916   unsigned int readonly : 1;    /* don't allow changes to the mailbox */
 917   unsigned int dontwrite : 1;   /* dont write the mailbox on close */
 918   unsigned int append : 1;      /* mailbox is opened in append mode */
 919   unsigned int quiet : 1;       /* inhibit status messages? */
 920   unsigned int collapsed : 1;   /* are all threads collapsed? */
 921   unsigned int closing : 1;     /* mailbox is being closed */
 922 } CONTEXT;
 923
 924 typedef struct attachptr
 925 {
 926   BODY *content;
 927   int parent_type;
 928   char *tree;
 929   int level;
 930   int num;
 931 } ATTACHPTR;
 932
 933 typedef struct
 934 {
 935   FILE *fpin;
 936   FILE *fpout;
 937   char *prefix;
 938   int flags;
 939 } STATE;
 940
 941 /* used by enter.c */
 942
 943 typedef struct
 944 {
 945   wchar_t *wbuf;
 946   size_t wbuflen;
 947   size_t lastchar;
 948   size_t curpos;
 949   size_t begin;
 950   int    tabs;
 951 } ENTER_STATE;
 952
 953 /* flags for the STATE struct */
 954 #define M_DISPLAY       (1<<0) /* output is displayed to the user */
 955 #define M_VERIFY        (1<<1) /* perform signature verification */
 956 #define M_PENDINGPREFIX (1<<2) /* prefix to write, but character must follow */
 957 #define M_WEED          (1<<3) /* weed headers even when not in display mode */
 958 #define M_CHARCONV      (1<<4) /* Do character set conversions */
 959 #define M_PRINTING      (1<<5) /* are we printing? - M_DISPLAY "light" */
 960 #define M_REPLYING      (1<<6) /* are we replying? */
 961 #define M_FIRSTDONE     (1<<7) /* the first attachment has been done */
 962
 963 #define state_set_prefix(s) ((s)->flags |= M_PENDINGPREFIX)
 964 #define state_reset_prefix(s) ((s)->flags &= ~M_PENDINGPREFIX)
 965 #define state_puts(x,y) fputs(x,(y)->fpout)
 966 #define state_putc(x,y) fputc(x,(y)->fpout)
 967
 968 void state_mark_attach (STATE *);
 969 void state_attach_puts (const char *, STATE *);
 970 void state_prefix_putc (char, STATE *);
 971 int  state_printf(STATE *, const char *, ...);
 972
 973 #include "ascii.h"
 974 #include "protos.h"
 975 #include "lib.h"
 976 #include "globals.h"
 977
 978 #endif /*MUTT_H*/