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,
381 OPTIMAPCHECKSUBSCRIBED,
387 #if defined(USE_SSL) || defined(USE_GNUTLS)
391 # endif /* !USE_GNUTLS */
395 #endif /* USE_SSL || USE_GNUTLS */
404 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
406 OPTMETAKEY, /* interpret ALT-x as ESC-x */
411 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
460 #ifdef HAVE_GETADDRINFO
467 OPTWRITEBCC, /* write out a bcc header? */
479 OPTCRYPTREPLYENCRYPT,
481 OPTCRYPTREPLYSIGNENCRYPTED,
485 OPTSDEFAULTDECRYPTKEY,
508 #endif /* USE_NNTP */
512 OPTAUXSORT, /* (pseudo) using auxillary sort function */
513 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
514 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
515 OPTNOCURSES, /* (pseudo) when sending in batch mode */
516 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
517 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
518 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
519 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
520 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
521 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
522 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
523 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
524 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
525 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
526 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
527 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
528 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
529 OPTATTACHMSG, /* (pseudo) used by attach-message */
530 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
531 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
532 * functions while we are executing an
535 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
536 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
537 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
538 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
539 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
542 OPTNEWS, /* (pseudo) used to change reader mode */
543 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
544 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
546 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
547 OPTSIDEBARNEWMAILONLY,
551 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
552 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
553 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
554 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
555 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
557 #define set_option(x) mutt_bit_set(Options,x)
558 #define unset_option(x) mutt_bit_unset(Options,x)
559 #define toggle_option(x) mutt_bit_toggle(Options,x)
560 #define option(x) mutt_bit_isset(Options,x)
562 typedef struct list_t {
567 typedef struct spam_list_t {
571 struct spam_list_t *next;
575 #define mutt_new_list() mem_calloc (1, sizeof (LIST))
576 #define mutt_new_spam_list() mem_calloc (1, sizeof (SPAM_LIST))
577 void mutt_free_list (LIST **);
578 void mutt_free_spam_list (SPAM_LIST **);
579 LIST *mutt_copy_list (LIST *);
580 int mutt_matches_ignore (const char *, LIST *);
582 /* add an element to a list */
583 LIST *mutt_add_list (LIST*, const char*);
584 LIST *mutt_add_list_n (LIST*, const void*, size_t len);
586 void mutt_init (int, LIST *);
588 typedef struct envelope {
589 ADDRESS *return_path;
596 ADDRESS *mail_followup_to;
597 char *list_post; /* this stores a mailto URL, or nothing */
599 char *real_subj; /* offset of the real subject */
612 LIST *references; /* message references (in reverse order) */
613 LIST *in_reply_to; /* in-reply-to header content */
614 LIST *userhdrs; /* user defined headers */
615 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
616 unsigned int refs_changed:1; /* References changed to break thread */
619 typedef struct parameter {
622 struct parameter *next;
625 /* Information that helps in determing the Content-* of an attachment */
626 typedef struct content {
627 long hibin; /* 8-bit characters */
628 long lobin; /* unprintable 7-bit chars (eg., control chars) */
629 long crlf; /* '\r' and '\n' characters */
630 long ascii; /* number of ascii chars */
631 long linemax; /* length of the longest line in the file */
632 unsigned int space:1; /* whitespace at the end of lines? */
633 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
634 unsigned int from:1; /* has a line beginning with "From "? */
635 unsigned int dot:1; /* has a line consisting of a single dot? */
636 unsigned int cr:1; /* has CR, even when in a CRLF pair */
639 typedef struct body {
640 char *xtype; /* content-type if x-unknown */
641 char *subtype; /* content-type subtype */
642 PARAMETER *parameter; /* parameters of the content-type */
643 char *description; /* content-description */
644 char *form_name; /* Content-Disposition form-data name param */
645 long hdr_offset; /* offset in stream where the headers begin.
646 * this info is used when invoking metamail,
647 * where we need to send the headers of the
650 long offset; /* offset where the actual data begins */
651 long length; /* length (in bytes) of attachment */
652 char *filename; /* when sending a message, this is the file
653 * to which this structure refers
655 char *d_filename; /* filename to be used for the
656 * content-disposition header.
657 * If NULL, filename is used
660 char *file_charset; /* charset of attached file */
661 CONTENT *content; /* structure used to store detailed info about
662 * the content of the attachment. this is used
663 * to determine what content-transfer-encoding
664 * is required when sending mail.
666 struct body *next; /* next attachment in the list */
667 struct body *parts; /* parts of a multipart or message/rfc822 */
668 struct header *hdr; /* header information for message/rfc822 */
670 struct attachptr *aptr; /* Menu information, used in recvattach.c */
672 time_t stamp; /* time stamp of last
676 unsigned int type:4; /* content-type primary type */
677 unsigned int encoding:3; /* content-transfer-encoding */
678 unsigned int disposition:2; /* content-disposition */
679 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
680 unsigned int unlink:1; /* flag to indicate the the file named by
681 * "filename" should be unlink()ed before
682 * free()ing this structure
684 unsigned int tagged:1;
685 unsigned int deleted:1; /* attachment marked for deletion */
687 unsigned int noconv:1; /* don't do character set conversion */
688 unsigned int force_charset:1;
689 /* send mode: don't adjust the character
690 * set when in send-mode.
692 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
693 S/MIME signed-data correctly,
694 e.g. they use foo.p7m even for
695 the name of signed data. This
696 flag is used to keep track of
697 the actual message type. It
698 gets set during the verification
699 (which is done if the encryption
700 try failed) and check by the
701 function to figure the type of
704 unsigned int goodsig:1; /* good cryptographic signature */
705 unsigned int warnsig:1; /* maybe good signature */
706 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
708 unsigned int collapsed:1; /* used by recvattach */
712 typedef struct header {
713 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
714 see: crypt.h pgplib.h, smime.h */
716 unsigned int mime:1; /* has a Mime-Version header? */
717 unsigned int flagged:1; /* marked important? */
718 unsigned int tagged:1;
719 unsigned int appended:1; /* has been saved */
720 unsigned int purged:1; /* bypassing the trash folder */
721 unsigned int deleted:1;
722 unsigned int changed:1;
723 unsigned int attach_del:1; /* has an attachment marked for deletion */
726 unsigned int expired:1; /* already expired? */
727 unsigned int superseded:1; /* got superseded? */
728 unsigned int replied:1;
729 unsigned int subject_changed:1; /* used for threading */
730 unsigned int threaded:1; /* used for threading */
731 unsigned int display_subject:1; /* used for threading */
732 unsigned int recip_valid:1; /* is_recipient is valid */
733 unsigned int active:1; /* message is not to be removed */
734 unsigned int trash:1; /* message is marked as trashed on disk.
735 * This flag is used by the maildir_trash
739 /* timezone of the sender of this message */
740 unsigned int zhours:5;
741 unsigned int zminutes:6;
742 unsigned int zoccident:1;
744 /* bits used for caching when searching */
745 unsigned int searched:1;
746 unsigned int matched:1;
748 /* the following are used to support collapsing threads */
749 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
750 unsigned int limited:1; /* is this message in a limited view? */
751 size_t num_hidden; /* number of hidden messages in this view */
753 short recipient; /* user_is_recipient()'s return value, cached */
755 int pair; /* color-pair to use when displaying in the index */
757 time_t date_sent; /* time when the message was sent (UTC) */
758 time_t received; /* time when the message was placed in the mailbox */
759 long offset; /* where in the stream does this message begin? */
760 int lines; /* how many lines in the body of this message? */
761 int index; /* the absolute (unsorted) message number */
762 int msgno; /* number displayed to the user */
763 int virtual; /* virtual message number */
765 ENVELOPE *env; /* envelope information */
766 BODY *content; /* list of MIME parts */
772 char *tree; /* character string to print thread tree */
773 struct thread *thread;
780 int refno; /* message number on server */
783 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
784 void *data; /* driver-specific data */
787 char *maildir_flags; /* unknown maildir flags */
790 typedef struct thread {
791 unsigned int fake_thread:1;
792 unsigned int duplicate_thread:1;
793 unsigned int sort_children:1;
794 unsigned int check_subject:1;
795 unsigned int visible:1;
797 unsigned int subtree_visible:2;
798 unsigned int next_subtree_visible:1;
799 struct thread *parent;
800 struct thread *child;
808 /* flag to mutt_pattern_comp() */
809 #define M_FULL_MSG 1 /* enable body and header matching */
812 M_MATCH_FULL_ADDRESS = 1
815 typedef struct pattern_t {
821 struct pattern_t *next;
822 struct pattern_t *child; /* arguments to logical op */
830 time_t mtime_cur; /* used with maildir folders */
833 char *pattern; /* limit pattern string */
834 pattern_t *limit_pattern; /* compiled limit pattern */
836 HEADER *last_tag; /* last tagged msg. used to link threads */
837 THREAD *tree; /* top of thread tree */
838 HASH *id_hash; /* hash table by msg id */
839 HASH *subj_hash; /* hash table by subject */
840 HASH *thread_hash; /* hash table for threading */
841 int *v2r; /* mapping from virtual to real msgno */
842 int hdrmax; /* number of pointers in hdrs */
843 int msgcount; /* number of messages in the mailbox */
844 int vcount; /* the number of virtual messages */
845 int tagged; /* how many messages are tagged? */
846 int new; /* how many new messages? */
847 int unread; /* how many unread messages? */
848 int deleted; /* how many deleted messages */
849 int appended; /* how many saved messages? */
850 int flagged; /* how many flagged messages */
851 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
852 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
853 void *data; /* driver specific data */
854 #endif /* USE_IMAP */
856 short magic; /* mailbox type */
858 #ifdef USE_COMPRESSED
859 void *compressinfo; /* compressed mbox module private data */
860 char *realpath; /* path to compressed mailbox */
861 #endif /* USE_COMPRESSED */
863 unsigned int locked:1; /* is the mailbox locked? */
864 unsigned int changed:1; /* mailbox has been modified */
865 unsigned int readonly:1; /* don't allow changes to the mailbox */
866 unsigned int dontwrite:1; /* dont write the mailbox on close */
867 unsigned int append:1; /* mailbox is opened in append mode */
868 unsigned int quiet:1; /* inhibit status messages? */
869 unsigned int collapsed:1; /* are all threads collapsed? */
870 unsigned int closing:1; /* mailbox is being closed */
871 unsigned int counting:1; /* do we just want to cound? */
883 #endif /* !_MUTT_H */