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 */
368 #endif /* HAVE_QDBM */
376 OPTHIDETHREADSUBJECT,
379 OPTIGNORELISTREPLYTO,
385 # if defined(USE_SSL) || defined(USE_GNUTLS)
389 #if defined(USE_SSL) || defined(USE_NSS) || defined(USE_GNUTLS)
407 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
409 OPTMETAKEY, /* interpret ALT-x as ESC-x */
414 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
463 #ifdef HAVE_GETADDRINFO
470 OPTWRITEBCC, /* write out a bcc header? */
482 OPTCRYPTREPLYENCRYPT,
484 OPTCRYPTREPLYSIGNENCRYPTED,
488 OPTSDEFAULTDECRYPTKEY,
511 #endif /* USE_NNTP */
515 OPTAUXSORT, /* (pseudo) using auxillary sort function */
516 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
517 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
518 OPTNOCURSES, /* (pseudo) when sending in batch mode */
519 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
520 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
521 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
522 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
523 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
524 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
525 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
526 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
527 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
528 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
529 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
530 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
531 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
532 OPTATTACHMSG, /* (pseudo) used by attach-message */
533 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
534 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
535 * functions while we are executing an
538 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
539 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
540 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
541 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
542 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
545 OPTNEWS, /* (pseudo) used to change reader mode */
546 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
547 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
549 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
550 OPTSIDEBARNEWMAILONLY,
554 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
555 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
556 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
557 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
558 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
560 #define set_option(x) mutt_bit_set(Options,x)
561 #define unset_option(x) mutt_bit_unset(Options,x)
562 #define toggle_option(x) mutt_bit_toggle(Options,x)
563 #define option(x) mutt_bit_isset(Options,x)
565 /* Exit values used in send_msg() */
569 typedef struct list_t {
574 typedef struct spam_list_t {
578 struct spam_list_t *next;
582 #define mutt_new_list() safe_calloc (1, sizeof (LIST))
583 #define mutt_new_spam_list() safe_calloc (1, sizeof (SPAM_LIST))
584 void mutt_free_list (LIST **);
585 void mutt_free_spam_list (SPAM_LIST **);
586 LIST *mutt_copy_list (LIST *);
587 int mutt_matches_ignore (const char *, LIST *);
589 /* add an element to a list */
590 LIST *mutt_add_list (LIST *, const char *);
592 void mutt_init (int, LIST *);
594 typedef struct alias {
595 struct alias *self; /* XXX - ugly hack */
604 typedef struct envelope {
605 ADDRESS *return_path;
612 ADDRESS *mail_followup_to;
613 char *list_post; /* this stores a mailto URL, or nothing */
615 char *real_subj; /* offset of the real subject */
628 LIST *references; /* message references (in reverse order) */
629 LIST *in_reply_to; /* in-reply-to header content */
630 LIST *userhdrs; /* user defined headers */
633 typedef struct parameter {
636 struct parameter *next;
639 /* Information that helps in determing the Content-* of an attachment */
640 typedef struct content {
641 long hibin; /* 8-bit characters */
642 long lobin; /* unprintable 7-bit chars (eg., control chars) */
643 long crlf; /* '\r' and '\n' characters */
644 long ascii; /* number of ascii chars */
645 long linemax; /* length of the longest line in the file */
646 unsigned int space:1; /* whitespace at the end of lines? */
647 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
648 unsigned int from:1; /* has a line beginning with "From "? */
649 unsigned int dot:1; /* has a line consisting of a single dot? */
650 unsigned int cr:1; /* has CR, even when in a CRLF pair */
653 typedef struct body {
654 char *xtype; /* content-type if x-unknown */
655 char *subtype; /* content-type subtype */
656 PARAMETER *parameter; /* parameters of the content-type */
657 char *description; /* content-description */
658 char *form_name; /* Content-Disposition form-data name param */
659 long hdr_offset; /* offset in stream where the headers begin.
660 * this info is used when invoking metamail,
661 * where we need to send the headers of the
664 long offset; /* offset where the actual data begins */
665 long length; /* length (in bytes) of attachment */
666 char *filename; /* when sending a message, this is the file
667 * to which this structure refers
669 char *d_filename; /* filename to be used for the
670 * content-disposition header.
671 * If NULL, filename is used
674 char *file_charset; /* charset of attached file */
675 CONTENT *content; /* structure used to store detailed info about
676 * the content of the attachment. this is used
677 * to determine what content-transfer-encoding
678 * is required when sending mail.
680 struct body *next; /* next attachment in the list */
681 struct body *parts; /* parts of a multipart or message/rfc822 */
682 struct header *hdr; /* header information for message/rfc822 */
684 struct attachptr *aptr; /* Menu information, used in recvattach.c */
686 time_t stamp; /* time stamp of last
690 unsigned int type:4; /* content-type primary type */
691 unsigned int encoding:3; /* content-transfer-encoding */
692 unsigned int disposition:2; /* content-disposition */
693 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
694 unsigned int unlink:1; /* flag to indicate the the file named by
695 * "filename" should be unlink()ed before
696 * free()ing this structure
698 unsigned int tagged:1;
699 unsigned int deleted:1; /* attachment marked for deletion */
701 unsigned int noconv:1; /* don't do character set conversion */
702 unsigned int force_charset:1;
703 /* send mode: don't adjust the character
704 * set when in send-mode.
706 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
707 S/MIME signed-data correctly,
708 e.g. they use foo.p7m even for
709 the name of signed data. This
710 flag is used to keep track of
711 the actual message type. It
712 gets set during the verification
713 (which is done if the encryption
714 try failed) and check by the
715 function to figure the type of
718 unsigned int goodsig:1; /* good cryptographic signature */
719 unsigned int warnsig:1; /* maybe good signature */
720 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
722 unsigned int collapsed:1; /* used by recvattach */
726 typedef struct header {
727 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
728 see: crypt.h pgplib.h, smime.h */
730 unsigned int mime:1; /* has a Mime-Version header? */
731 unsigned int flagged:1; /* marked important? */
732 unsigned int tagged:1;
733 unsigned int appended:1; /* has been saved */
734 unsigned int purged:1; /* bypassing the trash folder */
735 unsigned int deleted:1;
736 unsigned int changed:1;
737 unsigned int attach_del:1; /* has an attachment marked for deletion */
740 unsigned int expired:1; /* already expired? */
741 unsigned int superseded:1; /* got superseded? */
742 unsigned int replied:1;
743 unsigned int subject_changed:1; /* used for threading */
744 unsigned int threaded:1; /* used for threading */
745 unsigned int display_subject:1; /* used for threading */
746 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
747 unsigned int refs_changed:1; /* References changed to break thread */
748 unsigned int recip_valid:1; /* is_recipient is valid */
749 unsigned int active:1; /* message is not to be removed */
750 unsigned int trash:1; /* message is marked as trashed on disk.
751 * This flag is used by the maildir_trash
755 /* timezone of the sender of this message */
756 unsigned int zhours:5;
757 unsigned int zminutes:6;
758 unsigned int zoccident:1;
760 /* bits used for caching when searching */
761 unsigned int searched:1;
762 unsigned int matched:1;
764 /* the following are used to support collapsing threads */
765 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
766 unsigned int limited:1; /* is this message in a limited view? */
767 size_t num_hidden; /* number of hidden messages in this view */
769 short recipient; /* user_is_recipient()'s return value, cached */
771 int pair; /* color-pair to use when displaying in the index */
773 time_t date_sent; /* time when the message was sent (UTC) */
774 time_t received; /* time when the message was placed in the mailbox */
775 long offset; /* where in the stream does this message begin? */
776 int lines; /* how many lines in the body of this message? */
777 int index; /* the absolute (unsorted) message number */
778 int msgno; /* number displayed to the user */
779 int virtual; /* virtual message number */
781 ENVELOPE *env; /* envelope information */
782 BODY *content; /* list of MIME parts */
788 char *tree; /* character string to print thread tree */
789 struct thread *thread;
791 ENVELOPE *new_env; /* envelope information for rethreading */
798 int refno; /* message number on server */
801 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
802 void *data; /* driver-specific data */
805 char *maildir_flags; /* unknown maildir flags */
808 typedef struct thread {
809 unsigned int fake_thread:1;
810 unsigned int duplicate_thread:1;
811 unsigned int sort_children:1;
812 unsigned int check_subject:1;
813 unsigned int visible:1;
815 unsigned int subtree_visible:2;
816 unsigned int next_subtree_visible:1;
817 struct thread *parent;
818 struct thread *child;
826 /* flag to mutt_pattern_comp() */
827 #define M_FULL_MSG 1 /* enable body and header matching */
830 M_MATCH_FULL_ADDRESS = 1
833 typedef struct pattern_t {
839 struct pattern_t *next;
840 struct pattern_t *child; /* arguments to logical op */
848 time_t mtime_cur; /* used with maildir folders */
851 char *pattern; /* limit pattern string */
852 pattern_t *limit_pattern; /* compiled limit pattern */
854 HEADER *last_tag; /* last tagged msg. used to link threads */
855 THREAD *tree; /* top of thread tree */
856 HASH *id_hash; /* hash table by msg id */
857 HASH *subj_hash; /* hash table by subject */
858 HASH *thread_hash; /* hash table for threading */
859 int *v2r; /* mapping from virtual to real msgno */
860 int hdrmax; /* number of pointers in hdrs */
861 int msgcount; /* number of messages in the mailbox */
862 int vcount; /* the number of virtual messages */
863 int tagged; /* how many messages are tagged? */
864 int new; /* how many new messages? */
865 int unread; /* how many unread messages? */
866 int deleted; /* how many deleted messages */
867 int appended; /* how many saved messages? */
868 int flagged; /* how many flagged messages */
869 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
870 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
871 void *data; /* driver specific data */
872 #endif /* USE_IMAP */
874 short magic; /* mailbox type */
876 #ifdef USE_COMPRESSED
877 void *compressinfo; /* compressed mbox module private data */
878 char *realpath; /* path to compressed mailbox */
879 #endif /* USE_COMPRESSED */
881 unsigned int locked:1; /* is the mailbox locked? */
882 unsigned int changed:1; /* mailbox has been modified */
883 unsigned int readonly:1; /* don't allow changes to the mailbox */
884 unsigned int dontwrite:1; /* dont write the mailbox on close */
885 unsigned int append:1; /* mailbox is opened in append mode */
886 unsigned int quiet:1; /* inhibit status messages? */
887 unsigned int collapsed:1; /* are all threads collapsed? */
888 unsigned int closing:1; /* mailbox is being closed */
889 unsigned int counting:1; /* do we just want to cound? */
892 typedef struct attachptr {
907 /* used by enter.c */
918 /* flags for the STATE struct */
919 #define M_DISPLAY (1<<0) /* output is displayed to the user */
920 #define M_VERIFY (1<<1) /* perform signature verification */
921 #define M_PENDINGPREFIX (1<<2) /* prefix to write, but character must follow */
922 #define M_WEED (1<<3) /* weed headers even when not in display mode */
923 #define M_CHARCONV (1<<4) /* Do character set conversions */
924 #define M_PRINTING (1<<5) /* are we printing? - M_DISPLAY "light" */
925 #define M_REPLYING (1<<6) /* are we replying? */
926 #define M_FIRSTDONE (1<<7) /* the first attachment has been done */
928 #define state_set_prefix(s) ((s)->flags |= M_PENDINGPREFIX)
929 #define state_reset_prefix(s) ((s)->flags &= ~M_PENDINGPREFIX)
930 #define state_puts(x,y) fputs(x,(y)->fpout)
931 #define state_putc(x,y) fputc(x,(y)->fpout)
933 void state_mark_attach (STATE *);
934 void state_attach_puts (const char *, STATE *);
935 void state_prefix_putc (char, STATE *);
936 int state_printf (STATE *, const char *, ...);
943 #endif /* !_MUTT_H */