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>
54 # define MB_LEN_MAX 16
57 # define MUTT_VERSION (VERSION)
59 /* nifty trick I stole from ELM 2.5alpha. */
62 #define INITVAL(x) = x
68 /* flags for mutt_extract_token() */
69 #define M_TOKEN_EQUAL 1 /* treat '=' as a special */
70 #define M_TOKEN_CONDENSE (1<<1) /* ^(char) to control chars (macros) */
71 #define M_TOKEN_SPACE (1<<2) /* don't treat whitespace as a term */
72 #define M_TOKEN_QUOTE (1<<3) /* don't interpret quotes */
73 #define M_TOKEN_PATTERN (1<<4) /* !)|~ are terms (for patterns) */
74 #define M_TOKEN_COMMENT (1<<5) /* don't reap comments */
75 #define M_TOKEN_SEMICOLON (1<<6) /* don't treat ; as special */
78 char *data; /* pointer to data */
79 char *dptr; /* current read/write position */
80 size_t dsize; /* length of data */
81 int destroy; /* destroy `data' when done? */
85 int ch; /* raw key pressed */
86 int op; /* function op */
89 /* flags for _mutt_system() */
90 #define M_DETACH_PROCESS 1 /* detach subprocess from group */
92 /* flags for mutt_FormatString() */
94 M_FORMAT_FORCESUBJ = (1 << 0), /* print the subject even if unchanged */
95 M_FORMAT_TREE = (1 << 1), /* draw the thread tree */
96 M_FORMAT_MAKEPRINT = (1 << 2), /* make sure that all chars are printable */
97 M_FORMAT_OPTIONAL = (1 << 3),
98 M_FORMAT_STAT_FILE = (1 << 4), /* used by mutt_attach_fmt */
99 M_FORMAT_ARROWCURSOR = (1 << 5), /* reserve space for arrow_cursor */
100 M_FORMAT_INDEX = (1 << 6) /* this is a main index entry */
103 /* types for mutt_add_hook() */
104 #define M_FOLDERHOOK 1
105 #define M_MBOXHOOK (1<<1)
106 #define M_SENDHOOK (1<<2)
107 #define M_FCCHOOK (1<<3)
108 #define M_SAVEHOOK (1<<4)
109 #define M_CHARSETHOOK (1<<5)
110 #define M_ICONVHOOK (1<<6)
111 #define M_MESSAGEHOOK (1<<7)
112 #define M_CRYPTHOOK (1<<8)
113 #define M_ACCOUNTHOOK (1<<9)
114 #define M_REPLYHOOK (1<<10)
115 #define M_SEND2HOOK (1<<11)
117 #ifdef USE_COMPRESSED
118 #define M_OPENHOOK (1<<12)
119 #define M_APPENDHOOK (1<<13)
120 #define M_CLOSEHOOK (1<<14)
123 /* tree characters for linearize_tree and print_enriched_string */
124 #define M_TREE_LLCORNER 1
125 #define M_TREE_ULCORNER 2
126 #define M_TREE_LTEE 3
127 #define M_TREE_HLINE 4
128 #define M_TREE_VLINE 5
129 #define M_TREE_SPACE 6
130 #define M_TREE_RARROW 7
131 #define M_TREE_STAR 8
132 #define M_TREE_HIDDEN 9
133 #define M_TREE_EQUALS 10
134 #define M_TREE_TTEE 11
135 #define M_TREE_BTEE 12
136 #define M_TREE_MISSING 13
137 #define M_TREE_MAX 14
139 #define M_THREAD_COLLAPSE (1<<0)
140 #define M_THREAD_UNCOLLAPSE (1<<1)
141 #define M_THREAD_GET_HIDDEN (1<<2)
142 #define M_THREAD_UNREAD (1<<3)
143 #define M_THREAD_NEXT_UNREAD (1<<4)
146 /* modes for mutt_view_attachment() */
151 /* action codes used by mutt_set_flag() and mutt_pattern_function() */
171 /* actions for mutt_pattern_comp/mutt_pattern_exec */
209 /* Options for Mailcap lookup */
215 /* options for socket code */
221 /* Options for mutt_save_attachment */
226 /* possible arguments to set_quadoption() */
234 /* quad-option vars */
250 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
260 #if defined(USE_SSL) || defined(USE_GNUTLS)
264 OPT_VERIFYSIG, /* verify PGP signatures */
270 OPT_FOLLOWUPTOPOSTER,
271 #endif /* USE_NNTP */
273 /* THIS MUST BE THE LAST VALUE. */
277 /* flags to ci_send_message() */
278 #define SENDREPLY (1<<0)
279 #define SENDGROUPREPLY (1<<1)
280 #define SENDLISTREPLY (1<<2)
281 #define SENDFORWARD (1<<3)
282 #define SENDPOSTPONED (1<<4)
283 #define SENDBATCH (1<<5)
284 #define SENDMAILX (1<<6)
285 #define SENDKEY (1<<7)
286 #define SENDRESEND (1<<8)
287 #define SENDNEWS (1<<9)
289 /* flags to _mutt_select_file() */
290 #define M_SEL_BUFFY (1<<0)
291 #define M_SEL_MULTI (1<<1)
292 #define M_SEL_FOLDER (1<<2)
294 /* flags for parse_spam_list */
338 #endif /* HAVE_QDBM */
346 OPTHIDETHREADSUBJECT,
349 OPTIGNORELISTREPLYTO,
351 OPTIMAPCHECKSUBSCRIBED,
357 #if defined(USE_SSL) || defined(USE_GNUTLS)
361 # endif /* !USE_GNUTLS */
365 #endif /* USE_SSL || USE_GNUTLS */
374 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
376 OPTMETAKEY, /* interpret ALT-x as ESC-x */
381 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
430 #ifdef HAVE_GETADDRINFO
437 OPTWRITEBCC, /* write out a bcc header? */
439 OPTXMAILTO, /* 1 if $edit_header is forcebly set */
450 OPTCRYPTREPLYENCRYPT,
452 OPTCRYPTREPLYSIGNENCRYPTED,
456 OPTSDEFAULTDECRYPTKEY,
479 #endif /* USE_NNTP */
483 OPTAUXSORT, /* (pseudo) using auxillary sort function */
484 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
485 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
486 OPTNOCURSES, /* (pseudo) when sending in batch mode */
487 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
488 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
489 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
490 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
491 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
492 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
493 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
494 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
495 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
496 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
497 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
498 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
499 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
500 OPTATTACHMSG, /* (pseudo) used by attach-message */
501 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
502 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
503 * functions while we are executing an
506 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
507 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
508 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
509 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
510 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
513 OPTNEWS, /* (pseudo) used to change reader mode */
514 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
515 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
517 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
518 OPTSIDEBARNEWMAILONLY,
522 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
523 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
524 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
525 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
526 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
528 #define set_option(x) mutt_bit_set(Options,x)
529 #define unset_option(x) mutt_bit_unset(Options,x)
530 #define toggle_option(x) mutt_bit_toggle(Options,x)
531 #define option(x) mutt_bit_isset(Options,x)
533 typedef struct spam_list_t {
537 struct spam_list_t *next;
541 #define mutt_new_spam_list() mem_calloc (1, sizeof (SPAM_LIST))
542 void mutt_free_spam_list (SPAM_LIST **);
544 int mutt_matches_ignore (const char *, LIST *);
546 void mutt_init (int, LIST *);
548 typedef struct envelope {
549 ADDRESS *return_path;
556 ADDRESS *mail_followup_to;
557 char *list_post; /* this stores a mailto URL, or nothing */
559 char *real_subj; /* offset of the real subject */
572 LIST *references; /* message references (in reverse order) */
573 LIST *in_reply_to; /* in-reply-to header content */
574 LIST *userhdrs; /* user defined headers */
575 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
576 unsigned int refs_changed:1; /* References changed to break thread */
579 typedef struct parameter {
582 struct parameter *next;
585 /* Information that helps in determing the Content-* of an attachment */
586 typedef struct content {
587 long hibin; /* 8-bit characters */
588 long lobin; /* unprintable 7-bit chars (eg., control chars) */
589 long crlf; /* '\r' and '\n' characters */
590 long ascii; /* number of ascii chars */
591 long linemax; /* length of the longest line in the file */
592 unsigned int space:1; /* whitespace at the end of lines? */
593 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
594 unsigned int from:1; /* has a line beginning with "From "? */
595 unsigned int dot:1; /* has a line consisting of a single dot? */
596 unsigned int cr:1; /* has CR, even when in a CRLF pair */
599 typedef struct body {
600 char *xtype; /* content-type if x-unknown */
601 char *subtype; /* content-type subtype */
602 PARAMETER *parameter; /* parameters of the content-type */
603 char *description; /* content-description */
604 char *form_name; /* Content-Disposition form-data name param */
605 long hdr_offset; /* offset in stream where the headers begin.
606 * this info is used when invoking metamail,
607 * where we need to send the headers of the
610 long offset; /* offset where the actual data begins */
611 long length; /* length (in bytes) of attachment */
612 char *filename; /* when sending a message, this is the file
613 * to which this structure refers
615 char *d_filename; /* filename to be used for the
616 * content-disposition header.
617 * If NULL, filename is used
620 char *file_charset; /* charset of attached file */
621 CONTENT *content; /* structure used to store detailed info about
622 * the content of the attachment. this is used
623 * to determine what content-transfer-encoding
624 * is required when sending mail.
626 struct body *next; /* next attachment in the list */
627 struct body *parts; /* parts of a multipart or message/rfc822 */
628 struct header *hdr; /* header information for message/rfc822 */
630 struct attachptr *aptr; /* Menu information, used in recvattach.c */
632 time_t stamp; /* time stamp of last
636 unsigned int type:4; /* content-type primary type */
637 unsigned int encoding:3; /* content-transfer-encoding */
638 unsigned int disposition:2; /* content-disposition */
639 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
640 unsigned int unlink:1; /* flag to indicate the the file named by
641 * "filename" should be unlink()ed before
642 * free()ing this structure
644 unsigned int tagged:1;
645 unsigned int deleted:1; /* attachment marked for deletion */
647 unsigned int noconv:1; /* don't do character set conversion */
648 unsigned int force_charset:1;
649 /* send mode: don't adjust the character
650 * set when in send-mode.
652 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
653 S/MIME signed-data correctly,
654 e.g. they use foo.p7m even for
655 the name of signed data. This
656 flag is used to keep track of
657 the actual message type. It
658 gets set during the verification
659 (which is done if the encryption
660 try failed) and check by the
661 function to figure the type of
664 unsigned int goodsig:1; /* good cryptographic signature */
665 unsigned int warnsig:1; /* maybe good signature */
666 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
668 unsigned int collapsed:1; /* used by recvattach */
672 typedef struct header {
673 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
674 see: crypt.h pgplib.h, smime.h */
676 unsigned int mime:1; /* has a Mime-Version header? */
677 unsigned int flagged:1; /* marked important? */
678 unsigned int tagged:1;
679 unsigned int appended:1; /* has been saved */
680 unsigned int purged:1; /* bypassing the trash folder */
681 unsigned int deleted:1;
682 unsigned int changed:1;
683 unsigned int attach_del:1; /* has an attachment marked for deletion */
686 unsigned int expired:1; /* already expired? */
687 unsigned int superseded:1; /* got superseded? */
688 unsigned int replied:1;
689 unsigned int subject_changed:1; /* used for threading */
690 unsigned int threaded:1; /* used for threading */
691 unsigned int display_subject:1; /* used for threading */
692 unsigned int recip_valid:1; /* is_recipient is valid */
693 unsigned int active:1; /* message is not to be removed */
694 unsigned int trash:1; /* message is marked as trashed on disk.
695 * This flag is used by the maildir_trash
699 /* timezone of the sender of this message */
700 unsigned int zhours:5;
701 unsigned int zminutes:6;
702 unsigned int zoccident:1;
704 /* bits used for caching when searching */
705 unsigned int searched:1;
706 unsigned int matched:1;
708 /* the following are used to support collapsing threads */
709 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
710 unsigned int limited:1; /* is this message in a limited view? */
711 size_t num_hidden; /* number of hidden messages in this view */
713 short recipient; /* user_is_recipient()'s return value, cached */
715 int pair; /* color-pair to use when displaying in the index */
717 time_t date_sent; /* time when the message was sent (UTC) */
718 time_t received; /* time when the message was placed in the mailbox */
719 long offset; /* where in the stream does this message begin? */
720 int lines; /* how many lines in the body of this message? */
721 int index; /* the absolute (unsorted) message number */
722 int msgno; /* number displayed to the user */
723 int virtual; /* virtual message number */
725 ENVELOPE *env; /* envelope information */
726 BODY *content; /* list of MIME parts */
732 char *tree; /* character string to print thread tree */
733 struct thread *thread;
740 int refno; /* message number on server */
743 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
744 void *data; /* driver-specific data */
747 char *maildir_flags; /* unknown maildir flags */
750 typedef struct thread {
751 unsigned int fake_thread:1;
752 unsigned int duplicate_thread:1;
753 unsigned int sort_children:1;
754 unsigned int check_subject:1;
755 unsigned int visible:1;
757 unsigned int subtree_visible:2;
758 unsigned int next_subtree_visible:1;
759 struct thread *parent;
760 struct thread *child;
768 /* flag to mutt_pattern_comp() */
769 #define M_FULL_MSG 1 /* enable body and header matching */
772 M_MATCH_FULL_ADDRESS = 1
775 typedef struct pattern_t {
781 struct pattern_t *next;
782 struct pattern_t *child; /* arguments to logical op */
790 time_t mtime_cur; /* used with maildir folders */
793 char *pattern; /* limit pattern string */
794 pattern_t *limit_pattern; /* compiled limit pattern */
796 HEADER *last_tag; /* last tagged msg. used to link threads */
797 THREAD *tree; /* top of thread tree */
798 HASH *id_hash; /* hash table by msg id */
799 HASH *subj_hash; /* hash table by subject */
800 HASH *thread_hash; /* hash table for threading */
801 int *v2r; /* mapping from virtual to real msgno */
802 int hdrmax; /* number of pointers in hdrs */
803 int msgcount; /* number of messages in the mailbox */
804 int vcount; /* the number of virtual messages */
805 int tagged; /* how many messages are tagged? */
806 int new; /* how many new messages? */
807 int unread; /* how many unread messages? */
808 int deleted; /* how many deleted messages */
809 int appended; /* how many saved messages? */
810 int flagged; /* how many flagged messages */
811 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
812 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
813 void *data; /* driver specific data */
814 #endif /* USE_IMAP */
816 short magic; /* mailbox type */
818 #ifdef USE_COMPRESSED
819 void *compressinfo; /* compressed mbox module private data */
820 char *realpath; /* path to compressed mailbox */
821 #endif /* USE_COMPRESSED */
823 unsigned int locked:1; /* is the mailbox locked? */
824 unsigned int changed:1; /* mailbox has been modified */
825 unsigned int readonly:1; /* don't allow changes to the mailbox */
826 unsigned int dontwrite:1; /* dont write the mailbox on close */
827 unsigned int append:1; /* mailbox is opened in append mode */
828 unsigned int quiet:1; /* inhibit status messages? */
829 unsigned int collapsed:1; /* are all threads collapsed? */
830 unsigned int closing:1; /* mailbox is being closed */
831 unsigned int counting:1; /* do we just want to cound? */
838 #endif /* !_MUTT_H */