3 * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
4 * Copyright (C) 2004 g10 Code GmbH
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.
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.
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.
29 # include <unistd.h> /* needed for SEEK_SET */
32 # include <unix.h> /* needed for snprintf on QNX. */
34 #include <sys/types.h>
43 #if defined(HAVE_WCTYPE_H) && defined(HAVE_WC_FUNCS)
47 #ifndef _POSIX_PATH_MAX
48 #include <posix1_lim.h>
62 # define MB_LEN_MAX 16
66 # define MUTT_VERSION (VERSION SUBVERSION)
68 # define MUTT_VERSION (VERSION)
71 /* nifty trick I stole from ELM 2.5alpha. */
74 #define INITVAL(x) = x
80 #include "mutt_regex.h"
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: */
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 */
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 */
122 /* flags for km_dokey() */
123 #define M_KM_UNBUFFERED 1 /* don't read from the key buffer */
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? */
135 int ch; /* raw key pressed */
136 int op; /* function op */
139 /* flags for _mutt_system() */
140 #define M_DETACH_PROCESS 1 /* detach subprocess from group */
142 /* flags for mutt_FormatString() */
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 */
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)
168 #ifdef USE_COMPRESSED
169 #define M_OPENHOOK (1<<12)
170 #define M_APPENDHOOK (1<<13)
171 #define M_CLOSEHOOK (1<<14)
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
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)
198 /* modes for mutt_view_attachment() */
203 /* action codes used by mutt_set_flag() and mutt_pattern_function() */
223 /* actions for mutt_pattern_comp/mutt_pattern_exec */
259 /* Options for Mailcap lookup */
265 /* options for socket code */
271 /* Options for mutt_save_attachment */
276 /* possible arguments to set_quadoption() */
285 /* quad-option vars */
301 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
311 #if defined(USE_SSL) || defined(USE_GNUTLS)
315 OPT_VERIFYSIG, /* verify PGP signatures */
321 OPT_FOLLOWUPTOPOSTER,
322 #endif /* USE_NNTP */
324 /* THIS MUST BE THE LAST VALUE. */
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)
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)
345 /* flags for parse_spam_list */
392 OPTHIDETHREADSUBJECT,
395 OPTIGNORELISTREPLYTO,
401 # if defined(USE_SSL) || defined(USE_GNUTLS)
405 #if defined(USE_SSL) || defined(USE_NSS) || defined(USE_GNUTLS)
423 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
424 OPTMETAKEY, /* interpret ALT-x as ESC-x */
429 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
475 #ifdef HAVE_GETADDRINFO
482 OPTWRITEBCC, /* write out a bcc header? */
494 OPTCRYPTREPLYENCRYPT,
496 OPTCRYPTREPLYSIGNENCRYPTED,
500 OPTSDEFAULTDECRYPTKEY,
523 #endif /* USE_NNTP */
527 OPTAUXSORT, /* (pseudo) using auxillary sort function */
528 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
529 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
530 OPTNOCURSES, /* (pseudo) when sending in batch mode */
531 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
532 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
533 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
534 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
535 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
536 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
537 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
538 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
539 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
540 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
541 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
542 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
543 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
544 OPTATTACHMSG, /* (pseudo) used by attach-message */
545 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
546 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
547 * functions while we are executing an
550 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
551 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
552 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
553 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
554 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
557 OPTNEWS, /* (pseudo) used to change reader mode */
558 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
559 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
561 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
566 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
567 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
568 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
569 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
570 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
572 #define set_option(x) mutt_bit_set(Options,x)
573 #define unset_option(x) mutt_bit_unset(Options,x)
574 #define toggle_option(x) mutt_bit_toggle(Options,x)
575 #define option(x) mutt_bit_isset(Options,x)
577 /* Exit values used in send_msg() */
581 typedef struct list_t
587 typedef struct rx_list_t
590 struct rx_list_t *next;
593 typedef struct spam_list_t
598 struct spam_list_t *next;
602 #define mutt_new_list() safe_calloc (1, sizeof (LIST))
603 #define mutt_new_spam_list() safe_calloc (1, sizeof (SPAM_LIST))
604 #define mutt_new_rx_list() safe_calloc (1, sizeof (RX_LIST))
605 void mutt_free_list (LIST **);
606 void mutt_free_rx_list (RX_LIST **);
607 void mutt_free_spam_list (SPAM_LIST **);
608 LIST *mutt_copy_list (LIST *);
609 int mutt_matches_ignore (const char *, LIST *);
610 /* add an element to a list */
611 LIST *mutt_add_list (LIST *, const char *);
613 void mutt_init (int, LIST *);
617 struct alias *self; /* XXX - ugly hack */
626 typedef struct envelope
628 ADDRESS *return_path;
635 ADDRESS *mail_followup_to;
636 char *list_post; /* this stores a mailto URL, or nothing */
638 char *real_subj; /* offset of the real subject */
651 LIST *references; /* message references (in reverse order) */
652 LIST *in_reply_to; /* in-reply-to header content */
653 LIST *userhdrs; /* user defined headers */
656 typedef struct parameter
660 struct parameter *next;
663 /* Information that helps in determing the Content-* of an attachment */
664 typedef struct content
666 long hibin; /* 8-bit characters */
667 long lobin; /* unprintable 7-bit chars (eg., control chars) */
668 long crlf; /* '\r' and '\n' characters */
669 long ascii; /* number of ascii chars */
670 long linemax; /* length of the longest line in the file */
671 unsigned int space : 1; /* whitespace at the end of lines? */
672 unsigned int binary : 1; /* long lines, or CR not in CRLF pair */
673 unsigned int from : 1; /* has a line beginning with "From "? */
674 unsigned int dot : 1; /* has a line consisting of a single dot? */
675 unsigned int cr : 1; /* has CR, even when in a CRLF pair */
680 char *xtype; /* content-type if x-unknown */
681 char *subtype; /* content-type subtype */
682 PARAMETER *parameter; /* parameters of the content-type */
683 char *description; /* content-description */
684 char *form_name; /* Content-Disposition form-data name param */
685 long hdr_offset; /* offset in stream where the headers begin.
686 * this info is used when invoking metamail,
687 * where we need to send the headers of the
690 long offset; /* offset where the actual data begins */
691 long length; /* length (in bytes) of attachment */
692 char *filename; /* when sending a message, this is the file
693 * to which this structure refers
695 char *d_filename; /* filename to be used for the
696 * content-disposition header.
697 * If NULL, filename is used
700 CONTENT *content; /* structure used to store detailed info about
701 * the content of the attachment. this is used
702 * to determine what content-transfer-encoding
703 * is required when sending mail.
705 struct body *next; /* next attachment in the list */
706 struct body *parts; /* parts of a multipart or message/rfc822 */
707 struct header *hdr; /* header information for message/rfc822 */
709 struct attachptr *aptr; /* Menu information, used in recvattach.c */
711 time_t stamp; /* time stamp of last
715 unsigned int type : 4; /* content-type primary type */
716 unsigned int encoding : 3; /* content-transfer-encoding */
717 unsigned int disposition : 2; /* content-disposition */
718 unsigned int use_disp : 1; /* Content-Disposition uses filename= ? */
719 unsigned int unlink : 1; /* flag to indicate the the file named by
720 * "filename" should be unlink()ed before
721 * free()ing this structure
723 unsigned int tagged : 1;
724 unsigned int deleted : 1; /* attachment marked for deletion */
726 unsigned int noconv : 1; /* don't do character set conversion */
727 unsigned int force_charset : 1;
728 /* send mode: don't adjust the character
729 * set when in send-mode.
731 unsigned int is_signed_data : 1; /* A lot of MUAs don't indicate
732 S/MIME signed-data correctly,
733 e.g. they use foo.p7m even for
734 the name of signed data. This
735 flag is used to keep track of
736 the actual message type. It
737 gets set during the verification
738 (which is done if the encryption
739 try failed) and check by the
740 function to figure the type of
743 unsigned int goodsig : 1; /* good cryptographic signature */
744 unsigned int warnsig : 1; /* maybe good signature */
745 unsigned int badsig : 1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
747 unsigned int collapsed : 1; /* used by recvattach */
751 typedef struct header
753 unsigned int security : 11; /* bit 0-6: flags, bit 7,8: application.
754 see: crypt.h pgplib.h, smime.h */
756 unsigned int mime : 1; /* has a Mime-Version header? */
757 unsigned int flagged : 1; /* marked important? */
758 unsigned int tagged : 1;
759 unsigned int appended : 1; /* has been saved */
760 unsigned int purged : 1; /* bypassing the trash folder */
761 unsigned int deleted : 1;
762 unsigned int changed : 1;
763 unsigned int attach_del : 1; /* has an attachment marked for deletion */
764 unsigned int old : 1;
765 unsigned int read : 1;
766 unsigned int expired : 1; /* already expired? */
767 unsigned int superseded : 1; /* got superseded? */
768 unsigned int replied : 1;
769 unsigned int subject_changed : 1; /* used for threading */
770 unsigned int threaded : 1; /* used for threading */
771 unsigned int display_subject : 1; /* used for threading */
772 unsigned int irt_changed : 1; /* In-Reply-To changed to link/break threads */
773 unsigned int refs_changed : 1; /* References changed to break thread */
774 unsigned int recip_valid : 1; /* is_recipient is valid */
775 unsigned int active : 1; /* message is not to be removed */
776 unsigned int trash : 1; /* message is marked as trashed on disk.
777 * This flag is used by the maildir_trash
781 /* timezone of the sender of this message */
782 unsigned int zhours : 5;
783 unsigned int zminutes : 6;
784 unsigned int zoccident : 1;
786 /* bits used for caching when searching */
787 unsigned int searched : 1;
788 unsigned int matched : 1;
790 /* the following are used to support collapsing threads */
791 unsigned int collapsed : 1; /* is this message part of a collapsed thread? */
792 unsigned int limited : 1; /* is this message in a limited view? */
793 size_t num_hidden; /* number of hidden messages in this view */
795 short recipient; /* user_is_recipient()'s return value, cached */
797 int pair; /* color-pair to use when displaying in the index */
799 time_t date_sent; /* time when the message was sent (UTC) */
800 time_t received; /* time when the message was placed in the mailbox */
801 long offset; /* where in the stream does this message begin? */
802 int lines; /* how many lines in the body of this message? */
803 int index; /* the absolute (unsorted) message number */
804 int msgno; /* number displayed to the user */
805 int virtual; /* virtual message number */
807 ENVELOPE *env; /* envelope information */
808 BODY *content; /* list of MIME parts */
814 char *tree; /* character string to print thread tree */
815 struct thread *thread;
817 #ifdef IMAP_EDIT_THREADS
818 ENVELOPE *new_env; /* envelope information for rethreading */
826 int refno; /* message number on server */
829 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
830 void *data; /* driver-specific data */
833 char *maildir_flags; /* unknown maildir flags */
836 typedef struct thread
838 unsigned int fake_thread : 1;
839 unsigned int duplicate_thread : 1;
840 unsigned int sort_children : 1;
841 unsigned int check_subject : 1;
842 unsigned int visible : 1;
843 unsigned int deep : 1;
844 unsigned int subtree_visible : 2;
845 unsigned int next_subtree_visible : 1;
846 struct thread *parent;
847 struct thread *child;
855 /* flag to mutt_pattern_comp() */
856 #define M_FULL_MSG 1 /* enable body and header matching */
859 M_MATCH_FULL_ADDRESS = 1
862 typedef struct pattern_t
869 struct pattern_t *next;
870 struct pattern_t *child; /* arguments to logical op */
879 time_t mtime_cur; /* used with maildir folders */
882 char *pattern; /* limit pattern string */
883 pattern_t *limit_pattern; /* compiled limit pattern */
885 HEADER *last_tag; /* last tagged msg. used to link threads */
886 THREAD *tree; /* top of thread tree */
887 HASH *id_hash; /* hash table by msg id */
888 HASH *subj_hash; /* hash table by subject */
889 HASH *thread_hash; /* hash table for threading */
890 int *v2r; /* mapping from virtual to real msgno */
891 int hdrmax; /* number of pointers in hdrs */
892 int msgcount; /* number of messages in the mailbox */
893 int vcount; /* the number of virtual messages */
894 int tagged; /* how many messages are tagged? */
895 int new; /* how many new messages? */
896 int unread; /* how many unread messages? */
897 int deleted; /* how many deleted messages */
898 int appended; /* how many saved messages? */
899 int flagged; /* how many flagged messages */
900 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
901 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
902 void *data; /* driver specific data */
903 #endif /* USE_IMAP */
905 short magic; /* mailbox type */
907 #ifdef USE_COMPRESSED
908 void *compressinfo; /* compressed mbox module private data */
909 char *realpath; /* path to compressed mailbox */
910 #endif /* USE_COMPRESSED */
912 unsigned int locked : 1; /* is the mailbox locked? */
913 unsigned int changed : 1; /* mailbox has been modified */
914 unsigned int readonly : 1; /* don't allow changes to the mailbox */
915 unsigned int dontwrite : 1; /* dont write the mailbox on close */
916 unsigned int append : 1; /* mailbox is opened in append mode */
917 unsigned int quiet : 1; /* inhibit status messages? */
918 unsigned int collapsed : 1; /* are all threads collapsed? */
919 unsigned int closing : 1; /* mailbox is being closed */
922 typedef struct attachptr
939 /* used by enter.c */
951 /* flags for the STATE struct */
952 #define M_DISPLAY (1<<0) /* output is displayed to the user */
953 #define M_VERIFY (1<<1) /* perform signature verification */
954 #define M_PENDINGPREFIX (1<<2) /* prefix to write, but character must follow */
955 #define M_WEED (1<<3) /* weed headers even when not in display mode */
956 #define M_CHARCONV (1<<4) /* Do character set conversions */
957 #define M_PRINTING (1<<5) /* are we printing? - M_DISPLAY "light" */
958 #define M_REPLYING (1<<6) /* are we replying? */
959 #define M_FIRSTDONE (1<<7) /* the first attachment has been done */
961 #define state_set_prefix(s) ((s)->flags |= M_PENDINGPREFIX)
962 #define state_reset_prefix(s) ((s)->flags &= ~M_PENDINGPREFIX)
963 #define state_puts(x,y) fputs(x,(y)->fpout)
964 #define state_putc(x,y) fputc(x,(y)->fpout)
966 void state_mark_attach (STATE *);
967 void state_attach_puts (const char *, STATE *);
968 void state_prefix_putc (char, STATE *);
969 int state_printf(STATE *, const char *, ...);