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 */
125 char *data; /* pointer to data */
126 char *dptr; /* current read/write position */
127 size_t dsize; /* length of data */
128 int destroy; /* destroy `data' when done? */
132 int ch; /* raw key pressed */
133 int op; /* function op */
136 /* flags for _mutt_system() */
137 #define M_DETACH_PROCESS 1 /* detach subprocess from group */
139 /* flags for mutt_FormatString() */
141 M_FORMAT_FORCESUBJ = (1 << 0), /* print the subject even if unchanged */
142 M_FORMAT_TREE = (1 << 1), /* draw the thread tree */
143 M_FORMAT_MAKEPRINT = (1 << 2), /* make sure that all chars are printable */
144 M_FORMAT_OPTIONAL = (1 << 3),
145 M_FORMAT_STAT_FILE = (1 << 4), /* used by mutt_attach_fmt */
146 M_FORMAT_ARROWCURSOR = (1 << 5), /* reserve space for arrow_cursor */
147 M_FORMAT_INDEX = (1 << 6) /* this is a main index entry */
150 /* types for mutt_add_hook() */
151 #define M_FOLDERHOOK 1
152 #define M_MBOXHOOK (1<<1)
153 #define M_SENDHOOK (1<<2)
154 #define M_FCCHOOK (1<<3)
155 #define M_SAVEHOOK (1<<4)
156 #define M_CHARSETHOOK (1<<5)
157 #define M_ICONVHOOK (1<<6)
158 #define M_MESSAGEHOOK (1<<7)
159 #define M_CRYPTHOOK (1<<8)
160 #define M_ACCOUNTHOOK (1<<9)
161 #define M_REPLYHOOK (1<<10)
162 #define M_SEND2HOOK (1<<11)
164 #ifdef USE_COMPRESSED
165 #define M_OPENHOOK (1<<12)
166 #define M_APPENDHOOK (1<<13)
167 #define M_CLOSEHOOK (1<<14)
170 /* tree characters for linearize_tree and print_enriched_string */
171 #define M_TREE_LLCORNER 1
172 #define M_TREE_ULCORNER 2
173 #define M_TREE_LTEE 3
174 #define M_TREE_HLINE 4
175 #define M_TREE_VLINE 5
176 #define M_TREE_SPACE 6
177 #define M_TREE_RARROW 7
178 #define M_TREE_STAR 8
179 #define M_TREE_HIDDEN 9
180 #define M_TREE_EQUALS 10
181 #define M_TREE_TTEE 11
182 #define M_TREE_BTEE 12
183 #define M_TREE_MISSING 13
184 #define M_TREE_MAX 14
186 #define M_THREAD_COLLAPSE (1<<0)
187 #define M_THREAD_UNCOLLAPSE (1<<1)
188 #define M_THREAD_GET_HIDDEN (1<<2)
189 #define M_THREAD_UNREAD (1<<3)
190 #define M_THREAD_NEXT_UNREAD (1<<4)
193 /* modes for mutt_view_attachment() */
198 /* action codes used by mutt_set_flag() and mutt_pattern_function() */
219 /* actions for mutt_pattern_comp/mutt_pattern_exec */
255 /* Options for Mailcap lookup */
261 /* options for socket code */
267 /* Options for mutt_save_attachment */
272 /* possible arguments to set_quadoption() */
280 /* quad-option vars */
295 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
305 #if defined(USE_SSL) || defined(USE_GNUTLS)
309 OPT_VERIFYSIG, /* verify PGP signatures */
315 OPT_FOLLOWUPTOPOSTER,
316 #endif /* USE_NNTP */
318 /* THIS MUST BE THE LAST VALUE. */
322 /* flags to ci_send_message() */
323 #define SENDREPLY (1<<0)
324 #define SENDGROUPREPLY (1<<1)
325 #define SENDLISTREPLY (1<<2)
326 #define SENDFORWARD (1<<3)
327 #define SENDPOSTPONED (1<<4)
328 #define SENDBATCH (1<<5)
329 #define SENDMAILX (1<<6)
330 #define SENDKEY (1<<7)
331 #define SENDRESEND (1<<8)
332 #define SENDNEWS (1<<9)
334 /* flags to _mutt_select_file() */
335 #define M_SEL_BUFFY (1<<0)
336 #define M_SEL_MULTI (1<<1)
337 #define M_SEL_FOLDER (1<<2)
339 /* flags for parse_spam_list */
386 OPTHIDETHREADSUBJECT,
389 OPTIGNORELISTREPLYTO,
395 # if defined(USE_SSL) || defined(USE_GNUTLS)
399 #if defined(USE_SSL) || defined(USE_NSS) || defined(USE_GNUTLS)
417 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
419 OPTMETAKEY, /* interpret ALT-x as ESC-x */
424 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
472 #ifdef HAVE_GETADDRINFO
479 OPTWRITEBCC, /* write out a bcc header? */
491 OPTCRYPTREPLYENCRYPT,
493 OPTCRYPTREPLYSIGNENCRYPTED,
497 OPTSDEFAULTDECRYPTKEY,
520 #endif /* USE_NNTP */
524 OPTAUXSORT, /* (pseudo) using auxillary sort function */
525 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
526 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
527 OPTNOCURSES, /* (pseudo) when sending in batch mode */
528 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
529 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
530 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
531 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
532 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
533 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
534 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
535 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
536 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
537 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
538 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
539 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
540 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
541 OPTATTACHMSG, /* (pseudo) used by attach-message */
542 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
543 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
544 * functions while we are executing an
547 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
548 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
549 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
550 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
551 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
554 OPTNEWS, /* (pseudo) used to change reader mode */
555 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
556 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
558 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
559 OPTSIDEBARNEWMAILONLY,
563 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
564 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
565 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
566 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
567 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
569 #define set_option(x) mutt_bit_set(Options,x)
570 #define unset_option(x) mutt_bit_unset(Options,x)
571 #define toggle_option(x) mutt_bit_toggle(Options,x)
572 #define option(x) mutt_bit_isset(Options,x)
574 /* Exit values used in send_msg() */
578 typedef struct list_t {
583 typedef struct rx_list_t {
585 struct rx_list_t *next;
588 typedef struct spam_list_t {
592 struct spam_list_t *next;
596 #define mutt_new_list() safe_calloc (1, sizeof (LIST))
597 #define mutt_new_spam_list() safe_calloc (1, sizeof (SPAM_LIST))
598 #define mutt_new_rx_list() safe_calloc (1, sizeof (RX_LIST))
599 void mutt_free_list (LIST **);
600 void mutt_free_rx_list (RX_LIST **);
601 void mutt_free_spam_list (SPAM_LIST **);
602 LIST *mutt_copy_list (LIST *);
603 int mutt_matches_ignore (const char *, LIST *);
605 /* add an element to a list */
606 LIST *mutt_add_list (LIST *, const char *);
608 void mutt_init (int, LIST *);
610 typedef struct alias {
611 struct alias *self; /* XXX - ugly hack */
620 typedef struct envelope {
621 ADDRESS *return_path;
628 ADDRESS *mail_followup_to;
629 char *list_post; /* this stores a mailto URL, or nothing */
631 char *real_subj; /* offset of the real subject */
644 LIST *references; /* message references (in reverse order) */
645 LIST *in_reply_to; /* in-reply-to header content */
646 LIST *userhdrs; /* user defined headers */
649 typedef struct parameter {
652 struct parameter *next;
655 /* Information that helps in determing the Content-* of an attachment */
656 typedef struct content {
657 long hibin; /* 8-bit characters */
658 long lobin; /* unprintable 7-bit chars (eg., control chars) */
659 long crlf; /* '\r' and '\n' characters */
660 long ascii; /* number of ascii chars */
661 long linemax; /* length of the longest line in the file */
662 unsigned int space:1; /* whitespace at the end of lines? */
663 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
664 unsigned int from:1; /* has a line beginning with "From "? */
665 unsigned int dot:1; /* has a line consisting of a single dot? */
666 unsigned int cr:1; /* has CR, even when in a CRLF pair */
669 typedef struct body {
670 char *xtype; /* content-type if x-unknown */
671 char *subtype; /* content-type subtype */
672 PARAMETER *parameter; /* parameters of the content-type */
673 char *description; /* content-description */
674 char *form_name; /* Content-Disposition form-data name param */
675 long hdr_offset; /* offset in stream where the headers begin.
676 * this info is used when invoking metamail,
677 * where we need to send the headers of the
680 long offset; /* offset where the actual data begins */
681 long length; /* length (in bytes) of attachment */
682 char *filename; /* when sending a message, this is the file
683 * to which this structure refers
685 char *d_filename; /* filename to be used for the
686 * content-disposition header.
687 * If NULL, filename is used
690 char *file_charset; /* charset of attached file */
691 CONTENT *content; /* structure used to store detailed info about
692 * the content of the attachment. this is used
693 * to determine what content-transfer-encoding
694 * is required when sending mail.
696 struct body *next; /* next attachment in the list */
697 struct body *parts; /* parts of a multipart or message/rfc822 */
698 struct header *hdr; /* header information for message/rfc822 */
700 struct attachptr *aptr; /* Menu information, used in recvattach.c */
702 time_t stamp; /* time stamp of last
706 unsigned int type:4; /* content-type primary type */
707 unsigned int encoding:3; /* content-transfer-encoding */
708 unsigned int disposition:2; /* content-disposition */
709 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
710 unsigned int unlink:1; /* flag to indicate the the file named by
711 * "filename" should be unlink()ed before
712 * free()ing this structure
714 unsigned int tagged:1;
715 unsigned int deleted:1; /* attachment marked for deletion */
717 unsigned int noconv:1; /* don't do character set conversion */
718 unsigned int force_charset:1;
719 /* send mode: don't adjust the character
720 * set when in send-mode.
722 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
723 S/MIME signed-data correctly,
724 e.g. they use foo.p7m even for
725 the name of signed data. This
726 flag is used to keep track of
727 the actual message type. It
728 gets set during the verification
729 (which is done if the encryption
730 try failed) and check by the
731 function to figure the type of
734 unsigned int goodsig:1; /* good cryptographic signature */
735 unsigned int warnsig:1; /* maybe good signature */
736 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
738 unsigned int collapsed:1; /* used by recvattach */
742 typedef struct header {
743 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
744 see: crypt.h pgplib.h, smime.h */
746 unsigned int mime:1; /* has a Mime-Version header? */
747 unsigned int flagged:1; /* marked important? */
748 unsigned int tagged:1;
749 unsigned int appended:1; /* has been saved */
750 unsigned int purged:1; /* bypassing the trash folder */
751 unsigned int deleted:1;
752 unsigned int changed:1;
753 unsigned int attach_del:1; /* has an attachment marked for deletion */
756 unsigned int expired:1; /* already expired? */
757 unsigned int superseded:1; /* got superseded? */
758 unsigned int replied:1;
759 unsigned int subject_changed:1; /* used for threading */
760 unsigned int threaded:1; /* used for threading */
761 unsigned int display_subject:1; /* used for threading */
762 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
763 unsigned int refs_changed:1; /* References changed to break thread */
764 unsigned int recip_valid:1; /* is_recipient is valid */
765 unsigned int active:1; /* message is not to be removed */
766 unsigned int trash:1; /* message is marked as trashed on disk.
767 * This flag is used by the maildir_trash
771 /* timezone of the sender of this message */
772 unsigned int zhours:5;
773 unsigned int zminutes:6;
774 unsigned int zoccident:1;
776 /* bits used for caching when searching */
777 unsigned int searched:1;
778 unsigned int matched:1;
780 /* the following are used to support collapsing threads */
781 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
782 unsigned int limited:1; /* is this message in a limited view? */
783 size_t num_hidden; /* number of hidden messages in this view */
785 short recipient; /* user_is_recipient()'s return value, cached */
787 int pair; /* color-pair to use when displaying in the index */
789 time_t date_sent; /* time when the message was sent (UTC) */
790 time_t received; /* time when the message was placed in the mailbox */
791 long offset; /* where in the stream does this message begin? */
792 int lines; /* how many lines in the body of this message? */
793 int index; /* the absolute (unsorted) message number */
794 int msgno; /* number displayed to the user */
795 int virtual; /* virtual message number */
797 ENVELOPE *env; /* envelope information */
798 BODY *content; /* list of MIME parts */
804 char *tree; /* character string to print thread tree */
805 struct thread *thread;
807 ENVELOPE *new_env; /* envelope information for rethreading */
814 int refno; /* message number on server */
817 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
818 void *data; /* driver-specific data */
821 char *maildir_flags; /* unknown maildir flags */
824 typedef struct thread {
825 unsigned int fake_thread:1;
826 unsigned int duplicate_thread:1;
827 unsigned int sort_children:1;
828 unsigned int check_subject:1;
829 unsigned int visible:1;
831 unsigned int subtree_visible:2;
832 unsigned int next_subtree_visible:1;
833 struct thread *parent;
834 struct thread *child;
842 /* flag to mutt_pattern_comp() */
843 #define M_FULL_MSG 1 /* enable body and header matching */
846 M_MATCH_FULL_ADDRESS = 1
849 typedef struct pattern_t {
855 struct pattern_t *next;
856 struct pattern_t *child; /* arguments to logical op */
864 time_t mtime_cur; /* used with maildir folders */
867 char *pattern; /* limit pattern string */
868 pattern_t *limit_pattern; /* compiled limit pattern */
870 HEADER *last_tag; /* last tagged msg. used to link threads */
871 THREAD *tree; /* top of thread tree */
872 HASH *id_hash; /* hash table by msg id */
873 HASH *subj_hash; /* hash table by subject */
874 HASH *thread_hash; /* hash table for threading */
875 int *v2r; /* mapping from virtual to real msgno */
876 int hdrmax; /* number of pointers in hdrs */
877 int msgcount; /* number of messages in the mailbox */
878 int vcount; /* the number of virtual messages */
879 int tagged; /* how many messages are tagged? */
880 int new; /* how many new messages? */
881 int unread; /* how many unread messages? */
882 int deleted; /* how many deleted messages */
883 int appended; /* how many saved messages? */
884 int flagged; /* how many flagged messages */
885 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
886 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
887 void *data; /* driver specific data */
888 #endif /* USE_IMAP */
890 short magic; /* mailbox type */
892 #ifdef USE_COMPRESSED
893 void *compressinfo; /* compressed mbox module private data */
894 char *realpath; /* path to compressed mailbox */
895 #endif /* USE_COMPRESSED */
897 unsigned int locked:1; /* is the mailbox locked? */
898 unsigned int changed:1; /* mailbox has been modified */
899 unsigned int readonly:1; /* don't allow changes to the mailbox */
900 unsigned int dontwrite:1; /* dont write the mailbox on close */
901 unsigned int append:1; /* mailbox is opened in append mode */
902 unsigned int quiet:1; /* inhibit status messages? */
903 unsigned int collapsed:1; /* are all threads collapsed? */
904 unsigned int closing:1; /* mailbox is being closed */
907 typedef struct attachptr {
922 /* used by enter.c */
933 /* flags for the STATE struct */
934 #define M_DISPLAY (1<<0) /* output is displayed to the user */
935 #define M_VERIFY (1<<1) /* perform signature verification */
936 #define M_PENDINGPREFIX (1<<2) /* prefix to write, but character must follow */
937 #define M_WEED (1<<3) /* weed headers even when not in display mode */
938 #define M_CHARCONV (1<<4) /* Do character set conversions */
939 #define M_PRINTING (1<<5) /* are we printing? - M_DISPLAY "light" */
940 #define M_REPLYING (1<<6) /* are we replying? */
941 #define M_FIRSTDONE (1<<7) /* the first attachment has been done */
943 #define state_set_prefix(s) ((s)->flags |= M_PENDINGPREFIX)
944 #define state_reset_prefix(s) ((s)->flags &= ~M_PENDINGPREFIX)
945 #define state_puts(x,y) fputs(x,(y)->fpout)
946 #define state_putc(x,y) fputc(x,(y)->fpout)
948 void state_mark_attach (STATE *);
949 void state_attach_puts (const char *, STATE *);
950 void state_prefix_putc (char, STATE *);
951 int state_printf (STATE *, const char *, ...);