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