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
56 # define MUTT_VERSION (VERSION)
58 /* nifty trick I stole from ELM 2.5alpha. */
61 #define INITVAL(x) = x
67 /* flags for mutt_copy_header() */
68 #define CH_UPDATE 1 /* update the status and x-status fields? */
69 #define CH_WEED (1<<1) /* weed the headers? */
70 #define CH_DECODE (1<<2) /* do RFC1522 decoding? */
71 #define CH_XMIT (1<<3) /* transmitting this message? */
72 #define CH_FROM (1<<4) /* retain the "From " message separator? */
73 #define CH_PREFIX (1<<5) /* use Prefix string? */
74 #define CH_NOSTATUS (1<<6) /* supress the status and x-status fields */
75 #define CH_REORDER (1<<7) /* Re-order output of headers */
76 #define CH_NONEWLINE (1<<8) /* don't output terminating newline */
77 #define CH_MIME (1<<9) /* ignore MIME fields */
78 #define CH_UPDATE_LEN (1<<10) /* update Lines: and Content-Length: */
79 #define CH_TXTPLAIN (1<<11) /* generate text/plain MIME headers */
80 #define CH_NOLEN (1<<12) /* don't write Content-Length: and Lines: */
81 #define CH_WEED_DELIVERED (1<<13) /* weed eventual Delivered-To headers */
82 #define CH_FORCE_FROM (1<<14) /* give CH_FROM precedence over CH_WEED? */
83 #define CH_NOQFROM (1<<15) /* give CH_FROM precedence over CH_WEED? */
84 #define CH_UPDATE_IRT (1<<16) /* update In-Reply-To: */
85 #define CH_UPDATE_REFS (1<<17) /* update References: */
87 /* flags for mutt_enter_string() */
88 #define M_ALIAS 1 /* do alias "completion" by calling up the alias-menu */
89 #define M_FILE (1<<1) /* do file completion */
90 #define M_EFILE (1<<2) /* do file completion, plus incoming folders */
91 #define M_CMD (1<<3) /* do completion on previous word */
92 #define M_PASS (1<<4) /* password mode (no echo) */
93 #define M_CLEAR (1<<5) /* clear input if printable character is pressed */
94 #define M_COMMAND (1<<6) /* do command completion */
95 #define M_PATTERN (1<<7) /* pattern mode - only used for history classes */
96 #define M_LASTFOLDER (1<<8) /* last-folder mode - hack hack hack */
98 /* flags for mutt_get_token() */
99 #define M_TOKEN_EQUAL 1 /* treat '=' as a special */
100 #define M_TOKEN_CONDENSE (1<<1) /* ^(char) to control chars (macros) */
101 #define M_TOKEN_SPACE (1<<2) /* don't treat whitespace as a term */
102 #define M_TOKEN_QUOTE (1<<3) /* don't interpret quotes */
103 #define M_TOKEN_PATTERN (1<<4) /* !)|~ are terms (for patterns) */
104 #define M_TOKEN_COMMENT (1<<5) /* don't reap comments */
105 #define M_TOKEN_SEMICOLON (1<<6) /* don't treat ; as special */
107 /* flags for km_dokey() */
108 #define M_KM_UNBUFFERED 1 /* don't read from the key buffer */
111 char *data; /* pointer to data */
112 char *dptr; /* current read/write position */
113 size_t dsize; /* length of data */
114 int destroy; /* destroy `data' when done? */
118 int ch; /* raw key pressed */
119 int op; /* function op */
122 /* flags for _mutt_system() */
123 #define M_DETACH_PROCESS 1 /* detach subprocess from group */
125 /* flags for mutt_FormatString() */
127 M_FORMAT_FORCESUBJ = (1 << 0), /* print the subject even if unchanged */
128 M_FORMAT_TREE = (1 << 1), /* draw the thread tree */
129 M_FORMAT_MAKEPRINT = (1 << 2), /* make sure that all chars are printable */
130 M_FORMAT_OPTIONAL = (1 << 3),
131 M_FORMAT_STAT_FILE = (1 << 4), /* used by mutt_attach_fmt */
132 M_FORMAT_ARROWCURSOR = (1 << 5), /* reserve space for arrow_cursor */
133 M_FORMAT_INDEX = (1 << 6) /* this is a main index entry */
136 /* types for mutt_add_hook() */
137 #define M_FOLDERHOOK 1
138 #define M_MBOXHOOK (1<<1)
139 #define M_SENDHOOK (1<<2)
140 #define M_FCCHOOK (1<<3)
141 #define M_SAVEHOOK (1<<4)
142 #define M_CHARSETHOOK (1<<5)
143 #define M_ICONVHOOK (1<<6)
144 #define M_MESSAGEHOOK (1<<7)
145 #define M_CRYPTHOOK (1<<8)
146 #define M_ACCOUNTHOOK (1<<9)
147 #define M_REPLYHOOK (1<<10)
148 #define M_SEND2HOOK (1<<11)
150 #ifdef USE_COMPRESSED
151 #define M_OPENHOOK (1<<12)
152 #define M_APPENDHOOK (1<<13)
153 #define M_CLOSEHOOK (1<<14)
156 /* tree characters for linearize_tree and print_enriched_string */
157 #define M_TREE_LLCORNER 1
158 #define M_TREE_ULCORNER 2
159 #define M_TREE_LTEE 3
160 #define M_TREE_HLINE 4
161 #define M_TREE_VLINE 5
162 #define M_TREE_SPACE 6
163 #define M_TREE_RARROW 7
164 #define M_TREE_STAR 8
165 #define M_TREE_HIDDEN 9
166 #define M_TREE_EQUALS 10
167 #define M_TREE_TTEE 11
168 #define M_TREE_BTEE 12
169 #define M_TREE_MISSING 13
170 #define M_TREE_MAX 14
172 #define M_THREAD_COLLAPSE (1<<0)
173 #define M_THREAD_UNCOLLAPSE (1<<1)
174 #define M_THREAD_GET_HIDDEN (1<<2)
175 #define M_THREAD_UNREAD (1<<3)
176 #define M_THREAD_NEXT_UNREAD (1<<4)
179 /* modes for mutt_view_attachment() */
184 /* action codes used by mutt_set_flag() and mutt_pattern_function() */
205 /* actions for mutt_pattern_comp/mutt_pattern_exec */
241 /* Options for Mailcap lookup */
247 /* options for socket code */
253 /* Options for mutt_save_attachment */
258 /* possible arguments to set_quadoption() */
266 /* quad-option vars */
281 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
291 #if defined(USE_SSL) || defined(USE_GNUTLS)
295 OPT_VERIFYSIG, /* verify PGP signatures */
301 OPT_FOLLOWUPTOPOSTER,
302 #endif /* USE_NNTP */
304 /* THIS MUST BE THE LAST VALUE. */
308 /* flags to ci_send_message() */
309 #define SENDREPLY (1<<0)
310 #define SENDGROUPREPLY (1<<1)
311 #define SENDLISTREPLY (1<<2)
312 #define SENDFORWARD (1<<3)
313 #define SENDPOSTPONED (1<<4)
314 #define SENDBATCH (1<<5)
315 #define SENDMAILX (1<<6)
316 #define SENDKEY (1<<7)
317 #define SENDRESEND (1<<8)
318 #define SENDNEWS (1<<9)
320 /* flags to _mutt_select_file() */
321 #define M_SEL_BUFFY (1<<0)
322 #define M_SEL_MULTI (1<<1)
323 #define M_SEL_FOLDER (1<<2)
325 /* flags for parse_spam_list */
367 #endif /* HAVE_QDBM */
375 OPTHIDETHREADSUBJECT,
378 OPTIGNORELISTREPLYTO,
384 # if defined(USE_SSL) || defined(USE_GNUTLS)
388 #if defined(USE_SSL) || defined(USE_NSS) || defined(USE_GNUTLS)
406 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
408 OPTMETAKEY, /* interpret ALT-x as ESC-x */
413 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
461 #ifdef HAVE_GETADDRINFO
468 OPTWRITEBCC, /* write out a bcc header? */
480 OPTCRYPTREPLYENCRYPT,
482 OPTCRYPTREPLYSIGNENCRYPTED,
486 OPTSDEFAULTDECRYPTKEY,
509 #endif /* USE_NNTP */
513 OPTAUXSORT, /* (pseudo) using auxillary sort function */
514 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
515 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
516 OPTNOCURSES, /* (pseudo) when sending in batch mode */
517 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
518 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
519 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
520 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
521 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
522 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
523 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
524 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
525 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
526 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
527 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
528 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
529 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
530 OPTATTACHMSG, /* (pseudo) used by attach-message */
531 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
532 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
533 * functions while we are executing an
536 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
537 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
538 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
539 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
540 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
543 OPTNEWS, /* (pseudo) used to change reader mode */
544 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
545 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
547 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
548 OPTSIDEBARNEWMAILONLY,
552 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
553 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
554 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
555 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
556 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
558 #define set_option(x) mutt_bit_set(Options,x)
559 #define unset_option(x) mutt_bit_unset(Options,x)
560 #define toggle_option(x) mutt_bit_toggle(Options,x)
561 #define option(x) mutt_bit_isset(Options,x)
563 /* Exit values used in send_msg() */
567 typedef struct list_t {
572 typedef struct spam_list_t {
576 struct spam_list_t *next;
580 #define mutt_new_list() safe_calloc (1, sizeof (LIST))
581 #define mutt_new_spam_list() safe_calloc (1, sizeof (SPAM_LIST))
582 void mutt_free_list (LIST **);
583 void mutt_free_spam_list (SPAM_LIST **);
584 LIST *mutt_copy_list (LIST *);
585 int mutt_matches_ignore (const char *, LIST *);
587 /* add an element to a list */
588 LIST *mutt_add_list (LIST *, const char *);
590 void mutt_init (int, LIST *);
592 typedef struct alias {
593 struct alias *self; /* XXX - ugly hack */
602 typedef struct envelope {
603 ADDRESS *return_path;
610 ADDRESS *mail_followup_to;
611 char *list_post; /* this stores a mailto URL, or nothing */
613 char *real_subj; /* offset of the real subject */
626 LIST *references; /* message references (in reverse order) */
627 LIST *in_reply_to; /* in-reply-to header content */
628 LIST *userhdrs; /* user defined headers */
631 typedef struct parameter {
634 struct parameter *next;
637 /* Information that helps in determing the Content-* of an attachment */
638 typedef struct content {
639 long hibin; /* 8-bit characters */
640 long lobin; /* unprintable 7-bit chars (eg., control chars) */
641 long crlf; /* '\r' and '\n' characters */
642 long ascii; /* number of ascii chars */
643 long linemax; /* length of the longest line in the file */
644 unsigned int space:1; /* whitespace at the end of lines? */
645 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
646 unsigned int from:1; /* has a line beginning with "From "? */
647 unsigned int dot:1; /* has a line consisting of a single dot? */
648 unsigned int cr:1; /* has CR, even when in a CRLF pair */
651 typedef struct body {
652 char *xtype; /* content-type if x-unknown */
653 char *subtype; /* content-type subtype */
654 PARAMETER *parameter; /* parameters of the content-type */
655 char *description; /* content-description */
656 char *form_name; /* Content-Disposition form-data name param */
657 long hdr_offset; /* offset in stream where the headers begin.
658 * this info is used when invoking metamail,
659 * where we need to send the headers of the
662 long offset; /* offset where the actual data begins */
663 long length; /* length (in bytes) of attachment */
664 char *filename; /* when sending a message, this is the file
665 * to which this structure refers
667 char *d_filename; /* filename to be used for the
668 * content-disposition header.
669 * If NULL, filename is used
672 char *file_charset; /* charset of attached file */
673 CONTENT *content; /* structure used to store detailed info about
674 * the content of the attachment. this is used
675 * to determine what content-transfer-encoding
676 * is required when sending mail.
678 struct body *next; /* next attachment in the list */
679 struct body *parts; /* parts of a multipart or message/rfc822 */
680 struct header *hdr; /* header information for message/rfc822 */
682 struct attachptr *aptr; /* Menu information, used in recvattach.c */
684 time_t stamp; /* time stamp of last
688 unsigned int type:4; /* content-type primary type */
689 unsigned int encoding:3; /* content-transfer-encoding */
690 unsigned int disposition:2; /* content-disposition */
691 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
692 unsigned int unlink:1; /* flag to indicate the the file named by
693 * "filename" should be unlink()ed before
694 * free()ing this structure
696 unsigned int tagged:1;
697 unsigned int deleted:1; /* attachment marked for deletion */
699 unsigned int noconv:1; /* don't do character set conversion */
700 unsigned int force_charset:1;
701 /* send mode: don't adjust the character
702 * set when in send-mode.
704 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
705 S/MIME signed-data correctly,
706 e.g. they use foo.p7m even for
707 the name of signed data. This
708 flag is used to keep track of
709 the actual message type. It
710 gets set during the verification
711 (which is done if the encryption
712 try failed) and check by the
713 function to figure the type of
716 unsigned int goodsig:1; /* good cryptographic signature */
717 unsigned int warnsig:1; /* maybe good signature */
718 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
720 unsigned int collapsed:1; /* used by recvattach */
724 typedef struct header {
725 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
726 see: crypt.h pgplib.h, smime.h */
728 unsigned int mime:1; /* has a Mime-Version header? */
729 unsigned int flagged:1; /* marked important? */
730 unsigned int tagged:1;
731 unsigned int appended:1; /* has been saved */
732 unsigned int purged:1; /* bypassing the trash folder */
733 unsigned int deleted:1;
734 unsigned int changed:1;
735 unsigned int attach_del:1; /* has an attachment marked for deletion */
738 unsigned int expired:1; /* already expired? */
739 unsigned int superseded:1; /* got superseded? */
740 unsigned int replied:1;
741 unsigned int subject_changed:1; /* used for threading */
742 unsigned int threaded:1; /* used for threading */
743 unsigned int display_subject:1; /* used for threading */
744 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
745 unsigned int refs_changed:1; /* References changed to break thread */
746 unsigned int recip_valid:1; /* is_recipient is valid */
747 unsigned int active:1; /* message is not to be removed */
748 unsigned int trash:1; /* message is marked as trashed on disk.
749 * This flag is used by the maildir_trash
753 /* timezone of the sender of this message */
754 unsigned int zhours:5;
755 unsigned int zminutes:6;
756 unsigned int zoccident:1;
758 /* bits used for caching when searching */
759 unsigned int searched:1;
760 unsigned int matched:1;
762 /* the following are used to support collapsing threads */
763 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
764 unsigned int limited:1; /* is this message in a limited view? */
765 size_t num_hidden; /* number of hidden messages in this view */
767 short recipient; /* user_is_recipient()'s return value, cached */
769 int pair; /* color-pair to use when displaying in the index */
771 time_t date_sent; /* time when the message was sent (UTC) */
772 time_t received; /* time when the message was placed in the mailbox */
773 long offset; /* where in the stream does this message begin? */
774 int lines; /* how many lines in the body of this message? */
775 int index; /* the absolute (unsorted) message number */
776 int msgno; /* number displayed to the user */
777 int virtual; /* virtual message number */
779 ENVELOPE *env; /* envelope information */
780 BODY *content; /* list of MIME parts */
786 char *tree; /* character string to print thread tree */
787 struct thread *thread;
789 ENVELOPE *new_env; /* envelope information for rethreading */
796 int refno; /* message number on server */
799 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
800 void *data; /* driver-specific data */
803 char *maildir_flags; /* unknown maildir flags */
806 typedef struct thread {
807 unsigned int fake_thread:1;
808 unsigned int duplicate_thread:1;
809 unsigned int sort_children:1;
810 unsigned int check_subject:1;
811 unsigned int visible:1;
813 unsigned int subtree_visible:2;
814 unsigned int next_subtree_visible:1;
815 struct thread *parent;
816 struct thread *child;
824 /* flag to mutt_pattern_comp() */
825 #define M_FULL_MSG 1 /* enable body and header matching */
828 M_MATCH_FULL_ADDRESS = 1
831 typedef struct pattern_t {
837 struct pattern_t *next;
838 struct pattern_t *child; /* arguments to logical op */
846 time_t mtime_cur; /* used with maildir folders */
849 char *pattern; /* limit pattern string */
850 pattern_t *limit_pattern; /* compiled limit pattern */
852 HEADER *last_tag; /* last tagged msg. used to link threads */
853 THREAD *tree; /* top of thread tree */
854 HASH *id_hash; /* hash table by msg id */
855 HASH *subj_hash; /* hash table by subject */
856 HASH *thread_hash; /* hash table for threading */
857 int *v2r; /* mapping from virtual to real msgno */
858 int hdrmax; /* number of pointers in hdrs */
859 int msgcount; /* number of messages in the mailbox */
860 int vcount; /* the number of virtual messages */
861 int tagged; /* how many messages are tagged? */
862 int new; /* how many new messages? */
863 int unread; /* how many unread messages? */
864 int deleted; /* how many deleted messages */
865 int appended; /* how many saved messages? */
866 int flagged; /* how many flagged messages */
867 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
868 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
869 void *data; /* driver specific data */
870 #endif /* USE_IMAP */
872 short magic; /* mailbox type */
874 #ifdef USE_COMPRESSED
875 void *compressinfo; /* compressed mbox module private data */
876 char *realpath; /* path to compressed mailbox */
877 #endif /* USE_COMPRESSED */
879 unsigned int locked:1; /* is the mailbox locked? */
880 unsigned int changed:1; /* mailbox has been modified */
881 unsigned int readonly:1; /* don't allow changes to the mailbox */
882 unsigned int dontwrite:1; /* dont write the mailbox on close */
883 unsigned int append:1; /* mailbox is opened in append mode */
884 unsigned int quiet:1; /* inhibit status messages? */
885 unsigned int collapsed:1; /* are all threads collapsed? */
886 unsigned int closing:1; /* mailbox is being closed */
887 unsigned int counting:1; /* do we just want to cound? */
890 typedef struct attachptr {
905 /* used by enter.c */
916 /* flags for the STATE struct */
917 #define M_DISPLAY (1<<0) /* output is displayed to the user */
918 #define M_VERIFY (1<<1) /* perform signature verification */
919 #define M_PENDINGPREFIX (1<<2) /* prefix to write, but character must follow */
920 #define M_WEED (1<<3) /* weed headers even when not in display mode */
921 #define M_CHARCONV (1<<4) /* Do character set conversions */
922 #define M_PRINTING (1<<5) /* are we printing? - M_DISPLAY "light" */
923 #define M_REPLYING (1<<6) /* are we replying? */
924 #define M_FIRSTDONE (1<<7) /* the first attachment has been done */
926 #define state_set_prefix(s) ((s)->flags |= M_PENDINGPREFIX)
927 #define state_reset_prefix(s) ((s)->flags &= ~M_PENDINGPREFIX)
928 #define state_puts(x,y) fputs(x,(y)->fpout)
929 #define state_putc(x,y) fputc(x,(y)->fpout)
931 void state_mark_attach (STATE *);
932 void state_attach_puts (const char *, STATE *);
933 void state_prefix_putc (char, STATE *);
934 int state_printf (STATE *, const char *, ...);
941 #endif /* !_MUTT_H */