2 * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
27 # include <unistd.h> /* needed for SEEK_SET */
30 # include <unix.h> /* needed for snprintf on QNX. */
32 #include <sys/types.h>
41 #if defined(HAVE_WCTYPE_H) && defined(HAVE_WC_FUNCS)
45 #ifndef _POSIX_PATH_MAX
46 #include <posix1_lim.h>
60 # define MB_LEN_MAX 16
64 # define MUTT_VERSION (VERSION SUBVERSION)
66 # define MUTT_VERSION (VERSION)
69 /* nifty trick I stole from ELM 2.5alpha. */
72 #define INITVAL(x) = x
78 #include "mutt_regex.h"
80 /* flags for mutt_copy_header() */
81 #define CH_UPDATE 1 /* update the status and x-status fields? */
82 #define CH_WEED (1<<1) /* weed the headers? */
83 #define CH_DECODE (1<<2) /* do RFC1522 decoding? */
84 #define CH_XMIT (1<<3) /* transmitting this message? */
85 #define CH_FROM (1<<4) /* retain the "From " message separator? */
86 #define CH_PREFIX (1<<5) /* use Prefix string? */
87 #define CH_NOSTATUS (1<<6) /* supress the status and x-status fields */
88 #define CH_REORDER (1<<7) /* Re-order output of headers */
89 #define CH_NONEWLINE (1<<8) /* don't output terminating newline */
90 #define CH_MIME (1<<9) /* ignore MIME fields */
91 #define CH_UPDATE_LEN (1<<10) /* update Lines: and Content-Length: */
92 #define CH_TXTPLAIN (1<<11) /* generate text/plain MIME headers */
93 #define CH_NOLEN (1<<12) /* don't write Content-Length: and Lines: */
94 #define CH_WEED_DELIVERED (1<<13) /* weed eventual Delivered-To headers */
95 #define CH_FORCE_FROM (1<<14) /* give CH_FROM precedence over CH_WEED? */
96 #define CH_NOQFROM (1<<15) /* give CH_FROM precedence over CH_WEED? */
98 /* flags for mutt_enter_string() */
99 #define M_ALIAS 1 /* do alias "completion" by calling up the alias-menu */
100 #define M_FILE (1<<1) /* do file completion */
101 #define M_EFILE (1<<2) /* do file completion, plus incoming folders */
102 #define M_CMD (1<<3) /* do completion on previous word */
103 #define M_PASS (1<<4) /* password mode (no echo) */
104 #define M_CLEAR (1<<5) /* clear input if printable character is pressed */
105 #define M_COMMAND (1<<6) /* do command completion */
106 #define M_PATTERN (1<<7) /* pattern mode - only used for history classes */
108 /* flags for mutt_get_token() */
109 #define M_TOKEN_EQUAL 1 /* treat '=' as a special */
110 #define M_TOKEN_CONDENSE (1<<1) /* ^(char) to control chars (macros) */
111 #define M_TOKEN_SPACE (1<<2) /* don't treat whitespace as a term */
112 #define M_TOKEN_QUOTE (1<<3) /* don't interpret quotes */
113 #define M_TOKEN_PATTERN (1<<4) /* !)|~ are terms (for patterns) */
114 #define M_TOKEN_COMMENT (1<<5) /* don't reap comments */
115 #define M_TOKEN_SEMICOLON (1<<6) /* don't treat ; as special */
117 /* flags for km_dokey() */
118 #define M_KM_UNBUFFERED 1 /* don't read from the key buffer */
122 char *data; /* pointer to data */
123 char *dptr; /* current read/write position */
124 size_t dsize; /* length of data */
125 int destroy; /* destroy `data' when done? */
130 int ch; /* raw key pressed */
131 int op; /* function op */
134 /* flags for _mutt_system() */
135 #define M_DETACH_PROCESS 1 /* detach subprocess from group */
137 /* flags for mutt_FormatString() */
140 M_FORMAT_FORCESUBJ = (1<<0), /* print the subject even if unchanged */
141 M_FORMAT_TREE = (1<<1), /* draw the thread tree */
142 M_FORMAT_MAKEPRINT = (1<<2), /* make sure that all chars are printable */
143 M_FORMAT_OPTIONAL = (1<<3),
144 M_FORMAT_STAT_FILE = (1<<4), /* used by mutt_attach_fmt */
145 M_FORMAT_ARROWCURSOR = (1<<5), /* reserve space for arrow_cursor */
146 M_FORMAT_INDEX = (1<<6) /* this is a main index entry */
149 /* types for mutt_add_hook() */
150 #define M_FOLDERHOOK 1
151 #define M_MBOXHOOK (1<<1)
152 #define M_SENDHOOK (1<<2)
153 #define M_FCCHOOK (1<<3)
154 #define M_SAVEHOOK (1<<4)
155 #define M_CHARSETHOOK (1<<5)
156 #define M_ICONVHOOK (1<<6)
157 #define M_MESSAGEHOOK (1<<7)
158 #define M_CRYPTHOOK (1<<8)
159 #define M_ACCOUNTHOOK (1<<9)
160 #define M_REPLYHOOK (1<<10)
161 #ifdef USE_COMPRESSED
162 #define M_OPENHOOK (1<<12)
163 #define M_APPENDHOOK (1<<13)
164 #define M_CLOSEHOOK (1<<14)
167 /* tree characters for linearize_tree and print_enriched_string */
168 #define M_TREE_LLCORNER 1
169 #define M_TREE_ULCORNER 2
170 #define M_TREE_LTEE 3
171 #define M_TREE_HLINE 4
172 #define M_TREE_VLINE 5
173 #define M_TREE_SPACE 6
174 #define M_TREE_RARROW 7
175 #define M_TREE_STAR 8
176 #define M_TREE_HIDDEN 9
177 #define M_TREE_EQUALS 10
178 #define M_TREE_TTEE 11
179 #define M_TREE_BTEE 12
180 #define M_TREE_MISSING 13
181 #define M_TREE_MAX 14
183 #define M_THREAD_COLLAPSE (1<<0)
184 #define M_THREAD_UNCOLLAPSE (1<<1)
185 #define M_THREAD_GET_HIDDEN (1<<2)
186 #define M_THREAD_UNREAD (1<<3)
187 #define M_THREAD_NEXT_UNREAD (1<<4)
191 /* modes for mutt_view_attachment() */
196 /* action codes used by mutt_set_flag() and mutt_pattern_function() */
216 /* actions for mutt_pattern_comp/mutt_pattern_exec */
250 /* Options for Mailcap lookup */
256 /* options for socket code */
262 /* Options for mutt_save_attachment */
267 /* possible arguments to set_quadoption() */
276 /* quad-option vars */
289 OPT_PGPTRADITIONAL, /* create old-style PGP messages */
303 OPT_VERIFYSIG, /* verify PGP signatures */
309 OPT_FOLLOWUPTOPOSTER,
310 #endif /* USE_NNTP */
312 /* THIS MUST BE THE LAST VALUE. */
316 /* flags to ci_send_message() */
317 #define SENDREPLY (1<<0)
318 #define SENDGROUPREPLY (1<<1)
319 #define SENDLISTREPLY (1<<2)
320 #define SENDFORWARD (1<<3)
321 #define SENDPOSTPONED (1<<4)
322 #define SENDBATCH (1<<5)
323 #define SENDMAILX (1<<6)
324 #define SENDKEY (1<<7)
325 #define SENDRESEND (1<<8)
326 #define SENDNEWS (1<<9)
328 /* flags to _mutt_select_file() */
329 #define M_SEL_BUFFY (1<<0)
330 #define M_SEL_MULTI (1<<1)
331 #define M_SEL_FOLDER (1<<2)
376 OPTIGNORELISTREPLYTO,
386 #if defined(USE_SSL) || defined(USE_NSS)
399 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
400 OPTMETAKEY, /* interpret ALT-x as ESC-x */
405 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
446 #ifdef HAVE_GETADDRINFO
453 OPTWRITEBCC, /* write out a bcc header? */
464 OPTCRYPTREPLYENCRYPT,
466 OPTCRYPTREPLYSIGNENCRYPTED,
470 OPTSDEFAULTDECRYPTKEY,
491 #endif /* USE_NNTP */
495 OPTAUXSORT, /* (pseudo) using auxillary sort function */
496 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
497 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
498 OPTNOCURSES, /* (pseudo) when sending in batch mode */
499 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
500 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
501 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
502 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
503 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
504 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
505 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
506 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
507 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
508 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
509 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
510 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
511 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
512 OPTATTACHMSG, /* (pseudo) used by attach-message */
513 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
514 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
515 * functions while we are executing an
518 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
519 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
520 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
521 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
522 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
525 OPTNEWS, /* (pseudo) used to change reader mode */
526 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
527 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
533 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
534 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
535 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
536 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
537 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
539 #define set_option(x) mutt_bit_set(Options,x)
540 #define unset_option(x) mutt_bit_unset(Options,x)
541 #define toggle_option(x) mutt_bit_toggle(Options,x)
542 #define option(x) mutt_bit_isset(Options,x)
544 /* Exit values used in send_msg() */
548 typedef struct list_t
554 typedef struct rx_list_t
557 struct rx_list_t *next;
560 #define mutt_new_list() safe_calloc (1, sizeof (LIST))
561 #define mutt_new_rx_list() safe_calloc (1, sizeof (RX_LIST))
562 void mutt_free_list (LIST **);
563 void mutt_free_rx_list (RX_LIST **);
564 int mutt_matches_ignore (const char *, LIST *);
566 /* add an element to a list */
567 LIST *mutt_add_list (LIST *, const char *);
569 void mutt_init (int, LIST *);
573 struct alias *self; /* XXX - ugly hack */
582 typedef struct envelope
584 ADDRESS *return_path;
591 ADDRESS *mail_followup_to;
593 char *real_subj; /* offset of the real subject */
605 LIST *references; /* message references (in reverse order) */
606 LIST *in_reply_to; /* in-reply-to header content */
607 LIST *x_face; /* X-Face header content */
608 LIST *userhdrs; /* user defined headers */
611 typedef struct parameter
615 struct parameter *next;
618 /* Information that helps in determing the Content-* of an attachment */
619 typedef struct content
621 long hibin; /* 8-bit characters */
622 long lobin; /* unprintable 7-bit chars (eg., control chars) */
623 long crlf; /* '\r' and '\n' characters */
624 long ascii; /* number of ascii chars */
625 long linemax; /* length of the longest line in the file */
626 unsigned int space : 1; /* whitespace at the end of lines? */
627 unsigned int binary : 1; /* long lines, or CR not in CRLF pair */
628 unsigned int from : 1; /* has a line beginning with "From "? */
629 unsigned int dot : 1; /* has a line consisting of a single dot? */
630 unsigned int cr : 1; /* has CR, even when in a CRLF pair */
635 char *xtype; /* content-type if x-unknown */
636 char *subtype; /* content-type subtype */
637 PARAMETER *parameter; /* parameters of the content-type */
638 char *description; /* content-description */
639 char *form_name; /* Content-Disposition form-data name param */
640 long hdr_offset; /* offset in stream where the headers begin.
641 * this info is used when invoking metamail,
642 * where we need to send the headers of the
645 long offset; /* offset where the actual data begins */
646 long length; /* length (in bytes) of attachment */
647 char *filename; /* when sending a message, this is the file
648 * to which this structure refers
650 char *d_filename; /* filename to be used for the
651 * content-disposition header.
652 * If NULL, filename is used
655 CONTENT *content; /* structure used to store detailed info about
656 * the content of the attachment. this is used
657 * to determine what content-transfer-encoding
658 * is required when sending mail.
660 struct body *next; /* next attachment in the list */
661 struct body *parts; /* parts of a multipart or message/rfc822 */
662 struct header *hdr; /* header information for message/rfc822 */
664 struct attachptr *aptr; /* Menu information, used in recvattach.c */
666 time_t stamp; /* time stamp of last
670 unsigned int type : 4; /* content-type primary type */
671 unsigned int encoding : 3; /* content-transfer-encoding */
672 unsigned int disposition : 2; /* content-disposition */
673 unsigned int use_disp : 1; /* Content-Disposition uses filename= ? */
674 unsigned int unlink : 1; /* flag to indicate the the file named by
675 * "filename" should be unlink()ed before
676 * free()ing this structure
678 unsigned int tagged : 1;
679 unsigned int deleted : 1; /* attachment marked for deletion */
681 unsigned int noconv : 1; /* don't do character set conversion */
682 unsigned int force_charset : 1;
683 /* send mode: don't adjust the character
684 * set when in send-mode.
687 unsigned int goodsig : 1; /* good cryptographic signature */
688 unsigned int badsig : 1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
690 unsigned int collapsed : 1; /* used by recvattach */
694 typedef struct header
696 unsigned int security : 9; /* bit 0-6: flags, bit 7,8: application.
697 see: crypt.h pgplib.h, smime.h */
699 unsigned int mime : 1; /* has a Mime-Version header? */
700 unsigned int flagged : 1; /* marked important? */
701 unsigned int tagged : 1;
702 unsigned int appended : 1; /* has been saved */
703 unsigned int purged : 1; /* bypassing the trash folder */
704 unsigned int deleted : 1;
705 unsigned int changed : 1;
706 unsigned int attach_del : 1; /* has an attachment marked for deletion */
707 unsigned int old : 1;
708 unsigned int read : 1;
709 unsigned int expired : 1; /* already expired? */
710 unsigned int superseded : 1; /* got superseded? */
711 unsigned int replied : 1;
712 unsigned int subject_changed : 1; /* used for threading */
713 unsigned int threaded : 1; /* used for threading */
714 unsigned int display_subject : 1; /* used for threading */
715 unsigned int 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
722 /* timezone of the sender of this message */
723 unsigned int zhours : 5;
724 unsigned int zminutes : 6;
725 unsigned int zoccident : 1;
727 /* bits used for caching when searching */
728 unsigned int searched : 1;
729 unsigned int matched : 1;
731 /* the following are used to support collapsing threads */
732 unsigned int collapsed : 1; /* is this message part of a collapsed thread? */
733 unsigned int limited : 1; /* is this message in a limited view? */
734 size_t num_hidden; /* number of hidden messages in this view */
736 short recipient; /* user_is_recipient()'s return value, cached */
738 int pair; /* color-pair to use when displaying in the index */
740 time_t date_sent; /* time when the message was sent (UTC) */
741 time_t received; /* time when the message was placed in the mailbox */
742 long offset; /* where in the stream does this message begin? */
743 int lines; /* how many lines in the body of this message? */
744 int index; /* the absolute (unsorted) message number */
745 int msgno; /* number displayed to the user */
746 int virtual; /* virtual message number */
748 ENVELOPE *env; /* envelope information */
749 BODY *content; /* list of MIME parts */
755 char *tree; /* character string to print thread tree */
756 struct thread *thread;
763 int refno; /* message number on server */
766 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
767 void *data; /* driver-specific data */
770 char *maildir_flags; /* unknown maildir flags */
773 typedef struct thread
775 unsigned int fake_thread : 1;
776 unsigned int duplicate_thread : 1;
777 unsigned int sort_children : 1;
778 unsigned int check_subject : 1;
779 unsigned int visible : 1;
780 unsigned int deep : 1;
781 unsigned int subtree_visible : 2;
782 unsigned int next_subtree_visible : 1;
783 struct thread *parent;
784 struct thread *child;
792 /* flag to mutt_pattern_comp() */
793 #define M_FULL_MSG 1 /* enable body and header matching */
796 M_MATCH_FULL_ADDRESS = 1
799 typedef struct pattern_t
806 struct pattern_t *next;
807 struct pattern_t *child; /* arguments to logical op */
816 time_t mtime_cur; /* used with maildir folders */
819 char *pattern; /* limit pattern string */
820 pattern_t *limit_pattern; /* compiled limit pattern */
822 THREAD *tree; /* top of thread tree */
823 HASH *id_hash; /* hash table by msg id */
824 HASH *subj_hash; /* hash table by subject */
825 HASH *thread_hash; /* hash table for threading */
826 int *v2r; /* mapping from virtual to real msgno */
827 int hdrmax; /* number of pointers in hdrs */
828 int msgcount; /* number of messages in the mailbox */
829 int vcount; /* the number of virtual messages */
830 int tagged; /* how many messages are tagged? */
831 int new; /* how many new messages? */
832 int unread; /* how many unread messages? */
833 int deleted; /* how many deleted messages */
834 int appended; /* how many saved messages? */
835 int flagged; /* how many flagged messages */
836 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
837 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
838 void *data; /* driver specific data */
839 #endif /* USE_IMAP */
841 short magic; /* mailbox type */
843 #ifdef USE_COMPRESSED
844 void *compressinfo; /* compressed mbox module private data */
845 char *realpath; /* path to compressed mailbox */
846 #endif /* USE_COMPRESSED */
848 unsigned int locked : 1; /* is the mailbox locked? */
849 unsigned int changed : 1; /* mailbox has been modified */
850 unsigned int readonly : 1; /* don't allow changes to the mailbox */
851 unsigned int dontwrite : 1; /* dont write the mailbox on close */
852 unsigned int append : 1; /* mailbox is opened in append mode */
853 unsigned int quiet : 1; /* inhibit status messages? */
854 unsigned int collapsed : 1; /* are all threads collapsed? */
855 unsigned int closing : 1; /* mailbox is being closed */
858 typedef struct attachptr
875 /* used by enter.c */
887 /* flags for the STATE struct */
888 #define M_DISPLAY (1<<0) /* output is displayed to the user */
889 #define M_VERIFY (1<<1) /* perform signature verification */
890 #define M_PENDINGPREFIX (1<<2) /* prefix to write, but character must follow */
891 #define M_WEED (1<<3) /* weed headers even when not in display mode */
892 #define M_CHARCONV (1<<4) /* Do character set conversions */
893 #define M_PRINTING (1<<5) /* are we printing? - M_DISPLAY "light" */
895 #define state_set_prefix(s) ((s)->flags |= M_PENDINGPREFIX)
896 #define state_reset_prefix(s) ((s)->flags &= ~M_PENDINGPREFIX)
897 #define state_puts(x,y) fputs(x,(y)->fpout)
898 #define state_putc(x,y) fputc(x,(y)->fpout)
900 void state_mark_attach (STATE *);
901 void state_attach_puts (const char *, STATE *);
902 void state_prefix_putc (char, STATE *);
903 int state_printf(STATE *, const char *, ...);