2 * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
3 * Copyright (C) 2004 g10 Code GmbH
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.
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.
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.
28 # include <unistd.h> /* needed for SEEK_SET */
31 # include <unix.h> /* needed for snprintf on QNX. */
33 #include <sys/types.h>
42 #if defined(HAVE_WCTYPE_H) && defined(HAVE_WC_FUNCS)
46 #ifndef _POSIX_PATH_MAX
47 #include <posix1_lim.h>
61 # define MB_LEN_MAX 16
65 # define MUTT_VERSION (VERSION SUBVERSION)
67 # define MUTT_VERSION (VERSION)
70 /* nifty trick I stole from ELM 2.5alpha. */
73 #define INITVAL(x) = x
79 #include "mutt_regex.h"
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: */
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 */
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 */
121 /* flags for km_dokey() */
122 #define M_KM_UNBUFFERED 1 /* don't read from the key buffer */
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? */
134 int ch; /* raw key pressed */
135 int op; /* function op */
138 /* flags for _mutt_system() */
139 #define M_DETACH_PROCESS 1 /* detach subprocess from group */
141 /* flags for mutt_FormatString() */
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 */
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)
167 #ifdef USE_COMPRESSED
168 #define M_OPENHOOK (1<<12)
169 #define M_APPENDHOOK (1<<13)
170 #define M_CLOSEHOOK (1<<14)
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
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)
197 /* modes for mutt_view_attachment() */
202 /* 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 */
476 #ifdef HAVE_GETADDRINFO
483 OPTWRITEBCC, /* write out a bcc header? */
495 OPTCRYPTREPLYENCRYPT,
497 OPTCRYPTREPLYSIGNENCRYPTED,
501 OPTSDEFAULTDECRYPTKEY,
524 #endif /* USE_NNTP */
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
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 */
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 */
562 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
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)))
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)
578 /* Exit values used in send_msg() */
582 typedef struct list_t
588 typedef struct rx_list_t
591 struct rx_list_t *next;
594 typedef struct spam_list_t
599 struct spam_list_t *next;
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 *);
614 void mutt_init (int, LIST *);
618 struct alias *self; /* XXX - ugly hack */
627 typedef struct envelope
629 ADDRESS *return_path;
636 ADDRESS *mail_followup_to;
637 char *list_post; /* this stores a mailto URL, or nothing */
639 char *real_subj; /* offset of the real subject */
652 LIST *references; /* message references (in reverse order) */
653 LIST *in_reply_to; /* in-reply-to header content */
654 LIST *userhdrs; /* user defined headers */
657 typedef struct parameter
661 struct parameter *next;
664 /* Information that helps in determing the Content-* of an attachment */
665 typedef struct content
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 */
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
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
696 char *d_filename; /* filename to be used for the
697 * content-disposition header.
698 * If NULL, filename is used
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.
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 */
711 struct attachptr *aptr; /* Menu information, used in recvattach.c */
713 time_t stamp; /* time stamp of last
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
725 unsigned int tagged : 1;
726 unsigned int deleted : 1; /* attachment marked for deletion */
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.
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
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) */
749 unsigned int collapsed : 1; /* used by recvattach */
753 typedef struct header
755 unsigned int security : 11; /* bit 0-6: flags, bit 7,8: application.
756 see: crypt.h pgplib.h, smime.h */
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
783 /* timezone of the sender of this message */
784 unsigned int zhours : 5;
785 unsigned int zminutes : 6;
786 unsigned int zoccident : 1;
788 /* bits used for caching when searching */
789 unsigned int searched : 1;
790 unsigned int matched : 1;
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 */
797 short recipient; /* user_is_recipient()'s return value, cached */
799 int pair; /* color-pair to use when displaying in the index */
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 */
809 ENVELOPE *env; /* envelope information */
810 BODY *content; /* list of MIME parts */
816 char *tree; /* character string to print thread tree */
817 struct thread *thread;
819 #ifdef IMAP_EDIT_THREADS
820 ENVELOPE *new_env; /* envelope information for rethreading */
828 int refno; /* message number on server */
831 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
832 void *data; /* driver-specific data */
835 char *maildir_flags; /* unknown maildir flags */
838 typedef struct thread
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;
857 /* flag to mutt_pattern_comp() */
858 #define M_FULL_MSG 1 /* enable body and header matching */
861 M_MATCH_FULL_ADDRESS = 1
864 typedef struct pattern_t
871 struct pattern_t *next;
872 struct pattern_t *child; /* arguments to logical op */
881 time_t mtime_cur; /* used with maildir folders */
884 char *pattern; /* limit pattern string */
885 pattern_t *limit_pattern; /* compiled limit pattern */
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 */
907 short magic; /* mailbox type */
909 #ifdef USE_COMPRESSED
910 void *compressinfo; /* compressed mbox module private data */
911 char *realpath; /* path to compressed mailbox */
912 #endif /* USE_COMPRESSED */
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 */
924 typedef struct attachptr
941 /* used by enter.c */
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 */
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)
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 *, ...);