2 * Copyright notice from original mutt:
3 * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
4 * Copyright (C) 2004 g10 Code GmbH
6 * This file is part of mutt-ng, see http://www.muttng.org/.
7 * It's licensed under the GNU General Public License,
8 * please see the file GPL in the top level source directory.
19 # include <unistd.h> /* needed for SEEK_SET */
22 # include <unix.h> /* needed for snprintf on QNX. */
24 #include <sys/types.h>
33 #if defined(HAVE_WCTYPE_H) && defined(HAVE_WC_FUNCS)
37 #ifndef _POSIX_PATH_MAX
38 #include <posix1_lim.h>
53 # define MB_LEN_MAX 16
57 # define MUTT_VERSION (VERSION SUBVERSION)
59 # define MUTT_VERSION (VERSION)
62 /* nifty trick I stole from ELM 2.5alpha. */
65 #define INITVAL(x) = x
71 /* flags for mutt_copy_header() */
72 #define CH_UPDATE 1 /* update the status and x-status fields? */
73 #define CH_WEED (1<<1) /* weed the headers? */
74 #define CH_DECODE (1<<2) /* do RFC1522 decoding? */
75 #define CH_XMIT (1<<3) /* transmitting this message? */
76 #define CH_FROM (1<<4) /* retain the "From " message separator? */
77 #define CH_PREFIX (1<<5) /* use Prefix string? */
78 #define CH_NOSTATUS (1<<6) /* supress the status and x-status fields */
79 #define CH_REORDER (1<<7) /* Re-order output of headers */
80 #define CH_NONEWLINE (1<<8) /* don't output terminating newline */
81 #define CH_MIME (1<<9) /* ignore MIME fields */
82 #define CH_UPDATE_LEN (1<<10) /* update Lines: and Content-Length: */
83 #define CH_TXTPLAIN (1<<11) /* generate text/plain MIME headers */
84 #define CH_NOLEN (1<<12) /* don't write Content-Length: and Lines: */
85 #define CH_WEED_DELIVERED (1<<13) /* weed eventual Delivered-To headers */
86 #define CH_FORCE_FROM (1<<14) /* give CH_FROM precedence over CH_WEED? */
87 #define CH_NOQFROM (1<<15) /* give CH_FROM precedence over CH_WEED? */
88 #define CH_UPDATE_IRT (1<<16) /* update In-Reply-To: */
89 #define CH_UPDATE_REFS (1<<17) /* update References: */
91 /* flags for mutt_enter_string() */
92 #define M_ALIAS 1 /* do alias "completion" by calling up the alias-menu */
93 #define M_FILE (1<<1) /* do file completion */
94 #define M_EFILE (1<<2) /* do file completion, plus incoming folders */
95 #define M_CMD (1<<3) /* do completion on previous word */
96 #define M_PASS (1<<4) /* password mode (no echo) */
97 #define M_CLEAR (1<<5) /* clear input if printable character is pressed */
98 #define M_COMMAND (1<<6) /* do command completion */
99 #define M_PATTERN (1<<7) /* pattern mode - only used for history classes */
100 #define M_LASTFOLDER (1<<8) /* last-folder mode - hack hack hack */
102 /* flags for mutt_get_token() */
103 #define M_TOKEN_EQUAL 1 /* treat '=' as a special */
104 #define M_TOKEN_CONDENSE (1<<1) /* ^(char) to control chars (macros) */
105 #define M_TOKEN_SPACE (1<<2) /* don't treat whitespace as a term */
106 #define M_TOKEN_QUOTE (1<<3) /* don't interpret quotes */
107 #define M_TOKEN_PATTERN (1<<4) /* !)|~ are terms (for patterns) */
108 #define M_TOKEN_COMMENT (1<<5) /* don't reap comments */
109 #define M_TOKEN_SEMICOLON (1<<6) /* don't treat ; as special */
111 /* flags for km_dokey() */
112 #define M_KM_UNBUFFERED 1 /* don't read from the key buffer */
115 char *data; /* pointer to data */
116 char *dptr; /* current read/write position */
117 size_t dsize; /* length of data */
118 int destroy; /* destroy `data' when done? */
122 int ch; /* raw key pressed */
123 int op; /* function op */
126 /* flags for _mutt_system() */
127 #define M_DETACH_PROCESS 1 /* detach subprocess from group */
129 /* flags for mutt_FormatString() */
131 M_FORMAT_FORCESUBJ = (1 << 0), /* print the subject even if unchanged */
132 M_FORMAT_TREE = (1 << 1), /* draw the thread tree */
133 M_FORMAT_MAKEPRINT = (1 << 2), /* make sure that all chars are printable */
134 M_FORMAT_OPTIONAL = (1 << 3),
135 M_FORMAT_STAT_FILE = (1 << 4), /* used by mutt_attach_fmt */
136 M_FORMAT_ARROWCURSOR = (1 << 5), /* reserve space for arrow_cursor */
137 M_FORMAT_INDEX = (1 << 6) /* this is a main index entry */
140 /* types for mutt_add_hook() */
141 #define M_FOLDERHOOK 1
142 #define M_MBOXHOOK (1<<1)
143 #define M_SENDHOOK (1<<2)
144 #define M_FCCHOOK (1<<3)
145 #define M_SAVEHOOK (1<<4)
146 #define M_CHARSETHOOK (1<<5)
147 #define M_ICONVHOOK (1<<6)
148 #define M_MESSAGEHOOK (1<<7)
149 #define M_CRYPTHOOK (1<<8)
150 #define M_ACCOUNTHOOK (1<<9)
151 #define M_REPLYHOOK (1<<10)
152 #define M_SEND2HOOK (1<<11)
154 #ifdef USE_COMPRESSED
155 #define M_OPENHOOK (1<<12)
156 #define M_APPENDHOOK (1<<13)
157 #define M_CLOSEHOOK (1<<14)
160 /* tree characters for linearize_tree and print_enriched_string */
161 #define M_TREE_LLCORNER 1
162 #define M_TREE_ULCORNER 2
163 #define M_TREE_LTEE 3
164 #define M_TREE_HLINE 4
165 #define M_TREE_VLINE 5
166 #define M_TREE_SPACE 6
167 #define M_TREE_RARROW 7
168 #define M_TREE_STAR 8
169 #define M_TREE_HIDDEN 9
170 #define M_TREE_EQUALS 10
171 #define M_TREE_TTEE 11
172 #define M_TREE_BTEE 12
173 #define M_TREE_MISSING 13
174 #define M_TREE_MAX 14
176 #define M_THREAD_COLLAPSE (1<<0)
177 #define M_THREAD_UNCOLLAPSE (1<<1)
178 #define M_THREAD_GET_HIDDEN (1<<2)
179 #define M_THREAD_UNREAD (1<<3)
180 #define M_THREAD_NEXT_UNREAD (1<<4)
183 /* modes for mutt_view_attachment() */
188 /* action codes used by mutt_set_flag() and mutt_pattern_function() */
209 /* actions for mutt_pattern_comp/mutt_pattern_exec */
245 /* Options for Mailcap lookup */
251 /* options for socket code */
257 /* Options for mutt_save_attachment */
262 /* possible arguments to set_quadoption() */
270 /* quad-option vars */
285 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
295 #if defined(USE_SSL) || defined(USE_GNUTLS)
299 OPT_VERIFYSIG, /* verify PGP signatures */
305 OPT_FOLLOWUPTOPOSTER,
306 #endif /* USE_NNTP */
308 /* THIS MUST BE THE LAST VALUE. */
312 /* flags to ci_send_message() */
313 #define SENDREPLY (1<<0)
314 #define SENDGROUPREPLY (1<<1)
315 #define SENDLISTREPLY (1<<2)
316 #define SENDFORWARD (1<<3)
317 #define SENDPOSTPONED (1<<4)
318 #define SENDBATCH (1<<5)
319 #define SENDMAILX (1<<6)
320 #define SENDKEY (1<<7)
321 #define SENDRESEND (1<<8)
322 #define SENDNEWS (1<<9)
324 /* flags to _mutt_select_file() */
325 #define M_SEL_BUFFY (1<<0)
326 #define M_SEL_MULTI (1<<1)
327 #define M_SEL_FOLDER (1<<2)
329 /* flags for parse_spam_list */
371 #endif /* HAVE_QDBM */
379 OPTHIDETHREADSUBJECT,
382 OPTIGNORELISTREPLYTO,
388 # if defined(USE_SSL) || defined(USE_GNUTLS)
392 #if defined(USE_SSL) || defined(USE_NSS) || defined(USE_GNUTLS)
410 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
412 OPTMETAKEY, /* interpret ALT-x as ESC-x */
417 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
465 #ifdef HAVE_GETADDRINFO
472 OPTWRITEBCC, /* write out a bcc header? */
484 OPTCRYPTREPLYENCRYPT,
486 OPTCRYPTREPLYSIGNENCRYPTED,
490 OPTSDEFAULTDECRYPTKEY,
513 #endif /* USE_NNTP */
517 OPTAUXSORT, /* (pseudo) using auxillary sort function */
518 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
519 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
520 OPTNOCURSES, /* (pseudo) when sending in batch mode */
521 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
522 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
523 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
524 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
525 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
526 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
527 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
528 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
529 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
530 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
531 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
532 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
533 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
534 OPTATTACHMSG, /* (pseudo) used by attach-message */
535 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
536 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
537 * functions while we are executing an
540 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
541 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
542 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
543 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
544 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
547 OPTNEWS, /* (pseudo) used to change reader mode */
548 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
549 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
551 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
552 OPTSIDEBARNEWMAILONLY,
556 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
557 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
558 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
559 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
560 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
562 #define set_option(x) mutt_bit_set(Options,x)
563 #define unset_option(x) mutt_bit_unset(Options,x)
564 #define toggle_option(x) mutt_bit_toggle(Options,x)
565 #define option(x) mutt_bit_isset(Options,x)
567 /* Exit values used in send_msg() */
571 typedef struct list_t {
576 typedef struct spam_list_t {
580 struct spam_list_t *next;
584 #define mutt_new_list() safe_calloc (1, sizeof (LIST))
585 #define mutt_new_spam_list() safe_calloc (1, sizeof (SPAM_LIST))
586 void mutt_free_list (LIST **);
587 void mutt_free_spam_list (SPAM_LIST **);
588 LIST *mutt_copy_list (LIST *);
589 int mutt_matches_ignore (const char *, LIST *);
591 /* add an element to a list */
592 LIST *mutt_add_list (LIST *, const char *);
594 void mutt_init (int, LIST *);
596 typedef struct alias {
597 struct alias *self; /* XXX - ugly hack */
606 typedef struct envelope {
607 ADDRESS *return_path;
614 ADDRESS *mail_followup_to;
615 char *list_post; /* this stores a mailto URL, or nothing */
617 char *real_subj; /* offset of the real subject */
630 LIST *references; /* message references (in reverse order) */
631 LIST *in_reply_to; /* in-reply-to header content */
632 LIST *userhdrs; /* user defined headers */
635 typedef struct parameter {
638 struct parameter *next;
641 /* Information that helps in determing the Content-* of an attachment */
642 typedef struct content {
643 long hibin; /* 8-bit characters */
644 long lobin; /* unprintable 7-bit chars (eg., control chars) */
645 long crlf; /* '\r' and '\n' characters */
646 long ascii; /* number of ascii chars */
647 long linemax; /* length of the longest line in the file */
648 unsigned int space:1; /* whitespace at the end of lines? */
649 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
650 unsigned int from:1; /* has a line beginning with "From "? */
651 unsigned int dot:1; /* has a line consisting of a single dot? */
652 unsigned int cr:1; /* has CR, even when in a CRLF pair */
655 typedef struct body {
656 char *xtype; /* content-type if x-unknown */
657 char *subtype; /* content-type subtype */
658 PARAMETER *parameter; /* parameters of the content-type */
659 char *description; /* content-description */
660 char *form_name; /* Content-Disposition form-data name param */
661 long hdr_offset; /* offset in stream where the headers begin.
662 * this info is used when invoking metamail,
663 * where we need to send the headers of the
666 long offset; /* offset where the actual data begins */
667 long length; /* length (in bytes) of attachment */
668 char *filename; /* when sending a message, this is the file
669 * to which this structure refers
671 char *d_filename; /* filename to be used for the
672 * content-disposition header.
673 * If NULL, filename is used
676 char *file_charset; /* charset of attached file */
677 CONTENT *content; /* structure used to store detailed info about
678 * the content of the attachment. this is used
679 * to determine what content-transfer-encoding
680 * is required when sending mail.
682 struct body *next; /* next attachment in the list */
683 struct body *parts; /* parts of a multipart or message/rfc822 */
684 struct header *hdr; /* header information for message/rfc822 */
686 struct attachptr *aptr; /* Menu information, used in recvattach.c */
688 time_t stamp; /* time stamp of last
692 unsigned int type:4; /* content-type primary type */
693 unsigned int encoding:3; /* content-transfer-encoding */
694 unsigned int disposition:2; /* content-disposition */
695 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
696 unsigned int unlink:1; /* flag to indicate the the file named by
697 * "filename" should be unlink()ed before
698 * free()ing this structure
700 unsigned int tagged:1;
701 unsigned int deleted:1; /* attachment marked for deletion */
703 unsigned int noconv:1; /* don't do character set conversion */
704 unsigned int force_charset:1;
705 /* send mode: don't adjust the character
706 * set when in send-mode.
708 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
709 S/MIME signed-data correctly,
710 e.g. they use foo.p7m even for
711 the name of signed data. This
712 flag is used to keep track of
713 the actual message type. It
714 gets set during the verification
715 (which is done if the encryption
716 try failed) and check by the
717 function to figure the type of
720 unsigned int goodsig:1; /* good cryptographic signature */
721 unsigned int warnsig:1; /* maybe good signature */
722 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
724 unsigned int collapsed:1; /* used by recvattach */
728 typedef struct header {
729 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
730 see: crypt.h pgplib.h, smime.h */
732 unsigned int mime:1; /* has a Mime-Version header? */
733 unsigned int flagged:1; /* marked important? */
734 unsigned int tagged:1;
735 unsigned int appended:1; /* has been saved */
736 unsigned int purged:1; /* bypassing the trash folder */
737 unsigned int deleted:1;
738 unsigned int changed:1;
739 unsigned int attach_del:1; /* has an attachment marked for deletion */
742 unsigned int expired:1; /* already expired? */
743 unsigned int superseded:1; /* got superseded? */
744 unsigned int replied:1;
745 unsigned int subject_changed:1; /* used for threading */
746 unsigned int threaded:1; /* used for threading */
747 unsigned int display_subject:1; /* used for threading */
748 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
749 unsigned int refs_changed:1; /* References changed to break thread */
750 unsigned int recip_valid:1; /* is_recipient is valid */
751 unsigned int active:1; /* message is not to be removed */
752 unsigned int trash:1; /* message is marked as trashed on disk.
753 * This flag is used by the maildir_trash
757 /* timezone of the sender of this message */
758 unsigned int zhours:5;
759 unsigned int zminutes:6;
760 unsigned int zoccident:1;
762 /* bits used for caching when searching */
763 unsigned int searched:1;
764 unsigned int matched:1;
766 /* the following are used to support collapsing threads */
767 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
768 unsigned int limited:1; /* is this message in a limited view? */
769 size_t num_hidden; /* number of hidden messages in this view */
771 short recipient; /* user_is_recipient()'s return value, cached */
773 int pair; /* color-pair to use when displaying in the index */
775 time_t date_sent; /* time when the message was sent (UTC) */
776 time_t received; /* time when the message was placed in the mailbox */
777 long offset; /* where in the stream does this message begin? */
778 int lines; /* how many lines in the body of this message? */
779 int index; /* the absolute (unsorted) message number */
780 int msgno; /* number displayed to the user */
781 int virtual; /* virtual message number */
783 ENVELOPE *env; /* envelope information */
784 BODY *content; /* list of MIME parts */
790 char *tree; /* character string to print thread tree */
791 struct thread *thread;
793 ENVELOPE *new_env; /* envelope information for rethreading */
800 int refno; /* message number on server */
803 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
804 void *data; /* driver-specific data */
807 char *maildir_flags; /* unknown maildir flags */
810 typedef struct thread {
811 unsigned int fake_thread:1;
812 unsigned int duplicate_thread:1;
813 unsigned int sort_children:1;
814 unsigned int check_subject:1;
815 unsigned int visible:1;
817 unsigned int subtree_visible:2;
818 unsigned int next_subtree_visible:1;
819 struct thread *parent;
820 struct thread *child;
828 /* flag to mutt_pattern_comp() */
829 #define M_FULL_MSG 1 /* enable body and header matching */
832 M_MATCH_FULL_ADDRESS = 1
835 typedef struct pattern_t {
841 struct pattern_t *next;
842 struct pattern_t *child; /* arguments to logical op */
850 time_t mtime_cur; /* used with maildir folders */
853 char *pattern; /* limit pattern string */
854 pattern_t *limit_pattern; /* compiled limit pattern */
856 HEADER *last_tag; /* last tagged msg. used to link threads */
857 THREAD *tree; /* top of thread tree */
858 HASH *id_hash; /* hash table by msg id */
859 HASH *subj_hash; /* hash table by subject */
860 HASH *thread_hash; /* hash table for threading */
861 int *v2r; /* mapping from virtual to real msgno */
862 int hdrmax; /* number of pointers in hdrs */
863 int msgcount; /* number of messages in the mailbox */
864 int vcount; /* the number of virtual messages */
865 int tagged; /* how many messages are tagged? */
866 int new; /* how many new messages? */
867 int unread; /* how many unread messages? */
868 int deleted; /* how many deleted messages */
869 int appended; /* how many saved messages? */
870 int flagged; /* how many flagged messages */
871 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
872 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
873 void *data; /* driver specific data */
874 #endif /* USE_IMAP */
876 short magic; /* mailbox type */
878 #ifdef USE_COMPRESSED
879 void *compressinfo; /* compressed mbox module private data */
880 char *realpath; /* path to compressed mailbox */
881 #endif /* USE_COMPRESSED */
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 unsigned int counting:1; /* do we just want to cound? */
894 typedef struct attachptr {
909 /* used by enter.c */
920 /* flags for the STATE struct */
921 #define M_DISPLAY (1<<0) /* output is displayed to the user */
922 #define M_VERIFY (1<<1) /* perform signature verification */
923 #define M_PENDINGPREFIX (1<<2) /* prefix to write, but character must follow */
924 #define M_WEED (1<<3) /* weed headers even when not in display mode */
925 #define M_CHARCONV (1<<4) /* Do character set conversions */
926 #define M_PRINTING (1<<5) /* are we printing? - M_DISPLAY "light" */
927 #define M_REPLYING (1<<6) /* are we replying? */
928 #define M_FIRSTDONE (1<<7) /* the first attachment has been done */
930 #define state_set_prefix(s) ((s)->flags |= M_PENDINGPREFIX)
931 #define state_reset_prefix(s) ((s)->flags &= ~M_PENDINGPREFIX)
932 #define state_puts(x,y) fputs(x,(y)->fpout)
933 #define state_putc(x,y) fputc(x,(y)->fpout)
935 void state_mark_attach (STATE *);
936 void state_attach_puts (const char *, STATE *);
937 void state_prefix_putc (char, STATE *);
938 int state_printf (STATE *, const char *, ...);
945 #endif /* !_MUTT_H */