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>
44 #include <lib-lib/buffer.h>
45 #include <lib-lib/hash.h>
56 # define MB_LEN_MAX 16
59 # define MUTT_VERSION (VERSION)
61 /* nifty trick I stole from ELM 2.5alpha. */
64 #define INITVAL(x) = x
70 /* flags for mutt_extract_token() */
71 #define M_TOKEN_EQUAL 1 /* treat '=' as a special */
72 #define M_TOKEN_CONDENSE (1<<1) /* ^(char) to control chars (macros) */
73 #define M_TOKEN_SPACE (1<<2) /* don't treat whitespace as a term */
74 #define M_TOKEN_QUOTE (1<<3) /* don't interpret quotes */
75 #define M_TOKEN_PATTERN (1<<4) /* !)|~ are terms (for patterns) */
76 #define M_TOKEN_COMMENT (1<<5) /* don't reap comments */
77 #define M_TOKEN_SEMICOLON (1<<6) /* don't treat ; as special */
80 int ch; /* raw key pressed */
81 int op; /* function op */
84 /* flags for _mutt_system() */
85 #define M_DETACH_PROCESS 1 /* detach subprocess from group */
87 /* flags for mutt_FormatString() */
89 M_FORMAT_FORCESUBJ = (1 << 0), /* print the subject even if unchanged */
90 M_FORMAT_TREE = (1 << 1), /* draw the thread tree */
91 M_FORMAT_MAKEPRINT = (1 << 2), /* make sure that all chars are printable */
92 M_FORMAT_OPTIONAL = (1 << 3),
93 M_FORMAT_STAT_FILE = (1 << 4), /* used by mutt_attach_fmt */
94 M_FORMAT_ARROWCURSOR = (1 << 5), /* reserve space for arrow_cursor */
95 M_FORMAT_INDEX = (1 << 6) /* this is a main index entry */
98 /* types for mutt_add_hook() */
99 #define M_FOLDERHOOK 1
100 #define M_MBOXHOOK (1<<1)
101 #define M_SENDHOOK (1<<2)
102 #define M_FCCHOOK (1<<3)
103 #define M_SAVEHOOK (1<<4)
104 #define M_CHARSETHOOK (1<<5)
105 #define M_ICONVHOOK (1<<6)
106 #define M_MESSAGEHOOK (1<<7)
107 #define M_CRYPTHOOK (1<<8)
108 #define M_ACCOUNTHOOK (1<<9)
109 #define M_REPLYHOOK (1<<10)
110 #define M_SEND2HOOK (1<<11)
112 #ifdef USE_COMPRESSED
113 #define M_OPENHOOK (1<<12)
114 #define M_APPENDHOOK (1<<13)
115 #define M_CLOSEHOOK (1<<14)
118 /* tree characters for linearize_tree and print_enriched_string */
119 #define M_TREE_LLCORNER 1
120 #define M_TREE_ULCORNER 2
121 #define M_TREE_LTEE 3
122 #define M_TREE_HLINE 4
123 #define M_TREE_VLINE 5
124 #define M_TREE_SPACE 6
125 #define M_TREE_RARROW 7
126 #define M_TREE_STAR 8
127 #define M_TREE_HIDDEN 9
128 #define M_TREE_EQUALS 10
129 #define M_TREE_TTEE 11
130 #define M_TREE_BTEE 12
131 #define M_TREE_MISSING 13
132 #define M_TREE_MAX 14
134 #define M_THREAD_COLLAPSE (1<<0)
135 #define M_THREAD_UNCOLLAPSE (1<<1)
136 #define M_THREAD_GET_HIDDEN (1<<2)
137 #define M_THREAD_UNREAD (1<<3)
138 #define M_THREAD_NEXT_UNREAD (1<<4)
141 /* modes for mutt_view_attachment() */
146 /* action codes used by mutt_set_flag() and mutt_pattern_function() */
166 /* actions for mutt_pattern_comp/mutt_pattern_exec */
206 /* Options for Mailcap lookup */
212 /* options for socket code */
218 /* Options for mutt_save_attachment */
223 /* possible arguments to set_quadoption() */
231 /* quad-option vars */
247 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
257 #if defined(USE_SSL) || defined(USE_GNUTLS)
261 OPT_VERIFYSIG, /* verify PGP signatures */
267 OPT_FOLLOWUPTOPOSTER,
268 #endif /* USE_NNTP */
270 /* THIS MUST BE THE LAST VALUE. */
274 /* flags to ci_send_message() */
275 #define SENDREPLY (1<<0)
276 #define SENDGROUPREPLY (1<<1)
277 #define SENDLISTREPLY (1<<2)
278 #define SENDFORWARD (1<<3)
279 #define SENDPOSTPONED (1<<4)
280 #define SENDBATCH (1<<5)
281 #define SENDMAILX (1<<6)
282 #define SENDKEY (1<<7)
283 #define SENDRESEND (1<<8)
284 #define SENDNEWS (1<<9)
286 /* flags to _mutt_select_file() */
287 #define M_SEL_BUFFY (1<<0)
288 #define M_SEL_MULTI (1<<1)
289 #define M_SEL_FOLDER (1<<2)
291 /* flags for parse_spam_list */
336 #endif /* HAVE_QDBM */
344 OPTHIDETHREADSUBJECT,
347 OPTIGNORELISTREPLYTO,
349 OPTIMAPCHECKSUBSCRIBED,
355 #if defined(USE_SSL) || defined(USE_GNUTLS)
359 # endif /* !USE_GNUTLS */
363 #endif /* USE_SSL || USE_GNUTLS */
372 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
374 OPTMETAKEY, /* interpret ALT-x as ESC-x */
379 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
428 #ifdef HAVE_GETADDRINFO
435 OPTWRITEBCC, /* write out a bcc header? */
437 OPTXMAILTO, /* 1 if $edit_header is forcebly set */
448 OPTCRYPTREPLYENCRYPT,
450 OPTCRYPTREPLYSIGNENCRYPTED,
454 OPTSDEFAULTDECRYPTKEY,
477 #endif /* USE_NNTP */
481 OPTAUXSORT, /* (pseudo) using auxillary sort function */
482 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
483 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
484 OPTNOCURSES, /* (pseudo) when sending in batch mode */
485 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
486 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
487 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
488 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
489 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
490 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
491 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
492 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
493 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
494 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
495 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
496 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
497 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
498 OPTATTACHMSG, /* (pseudo) used by attach-message */
499 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
500 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
501 * functions while we are executing an
504 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
505 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
506 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
507 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
508 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
511 OPTNEWS, /* (pseudo) used to change reader mode */
512 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
513 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
515 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
516 OPTSIDEBARNEWMAILONLY,
520 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
521 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
522 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
523 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
524 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
526 #define set_option(x) mutt_bit_set(Options,x)
527 #define unset_option(x) mutt_bit_unset(Options,x)
528 #define toggle_option(x) mutt_bit_toggle(Options,x)
529 #define option(x) mutt_bit_isset(Options,x)
531 typedef struct spam_list_t {
535 struct spam_list_t *next;
539 #define mutt_new_spam_list() p_new(SPAM_LIST, 1)
540 void mutt_free_spam_list (SPAM_LIST **);
542 int mutt_matches_ignore (const char *, LIST *);
544 void mutt_init (int, LIST *);
546 typedef struct envelope {
547 ADDRESS *return_path;
554 ADDRESS *mail_followup_to;
555 char *list_post; /* this stores a mailto URL, or nothing */
557 char *real_subj; /* offset of the real subject */
570 LIST *references; /* message references (in reverse order) */
571 LIST *in_reply_to; /* in-reply-to header content */
572 LIST *userhdrs; /* user defined headers */
573 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
574 unsigned int refs_changed:1; /* References changed to break thread */
577 typedef struct parameter {
580 struct parameter *next;
583 /* Information that helps in determing the Content-* of an attachment */
584 typedef struct content {
585 long hibin; /* 8-bit characters */
586 long lobin; /* unprintable 7-bit chars (eg., control chars) */
587 long crlf; /* '\r' and '\n' characters */
588 long ascii; /* number of ascii chars */
589 long linemax; /* length of the longest line in the file */
590 unsigned int space:1; /* whitespace at the end of lines? */
591 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
592 unsigned int from:1; /* has a line beginning with "From "? */
593 unsigned int dot:1; /* has a line consisting of a single dot? */
594 unsigned int cr:1; /* has CR, even when in a CRLF pair */
597 typedef struct body {
598 char *xtype; /* content-type if x-unknown */
599 char *subtype; /* content-type subtype */
600 PARAMETER *parameter; /* parameters of the content-type */
601 char *description; /* content-description */
602 char *form_name; /* Content-Disposition form-data name param */
603 off_t hdr_offset; /* offset in stream where the headers begin.
604 * this info is used when invoking metamail,
605 * where we need to send the headers of the
608 off_t offset; /* offset where the actual data begins */
609 off_t length; /* length (in bytes) of attachment */
610 char *filename; /* when sending a message, this is the file
611 * to which this structure refers
613 char *d_filename; /* filename to be used for the
614 * content-disposition header.
615 * If NULL, filename is used
618 char *file_charset; /* charset of attached file */
619 CONTENT *content; /* structure used to store detailed info about
620 * the content of the attachment. this is used
621 * to determine what content-transfer-encoding
622 * is required when sending mail.
624 struct body *next; /* next attachment in the list */
625 struct body *parts; /* parts of a multipart or message/rfc822 */
626 struct header *hdr; /* header information for message/rfc822 */
628 struct attachptr *aptr; /* Menu information, used in recvattach.c */
630 signed short attach_count;
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 */
669 unsigned int attach_qualifies:1;
673 typedef struct header {
674 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
675 see: crypt.h pgplib.h, smime.h */
677 unsigned int mime:1; /* has a MIME-Version header? */
678 unsigned int flagged:1; /* marked important? */
679 unsigned int tagged:1;
680 unsigned int appended:1; /* has been saved */
681 unsigned int purged:1; /* bypassing the trash folder */
682 unsigned int deleted:1;
683 unsigned int changed:1;
684 unsigned int attach_del:1; /* has an attachment marked for deletion */
687 unsigned int expired:1; /* already expired? */
688 unsigned int superseded:1; /* got superseded? */
689 unsigned int replied:1;
690 unsigned int subject_changed:1; /* used for threading */
691 unsigned int threaded:1; /* used for threading */
692 unsigned int display_subject:1; /* used for threading */
693 unsigned int recip_valid:1; /* is_recipient is valid */
694 unsigned int active:1; /* message is not to be removed */
695 unsigned int trash:1; /* message is marked as trashed on disk.
696 * This flag is used by the maildir_trash
700 /* timezone of the sender of this message */
701 unsigned int zhours:5;
702 unsigned int zminutes:6;
703 unsigned int zoccident:1;
705 /* bits used for caching when searching */
706 unsigned int searched:1;
707 unsigned int matched:1;
709 /* tells whether the attach count is valid */
710 unsigned int attach_valid:1;
712 /* the following are used to support collapsing threads */
713 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
714 unsigned int limited:1; /* is this message in a limited view? */
715 size_t num_hidden; /* number of hidden messages in this view */
717 short recipient; /* user_is_recipient()'s return value, cached */
719 int pair; /* color-pair to use when displaying in the index */
721 time_t date_sent; /* time when the message was sent (UTC) */
722 time_t received; /* time when the message was placed in the mailbox */
723 off_t offset; /* where in the stream does this message begin? */
724 int lines; /* how many lines in the body of this message? */
725 int index; /* the absolute (unsorted) message number */
726 int msgno; /* number displayed to the user */
727 int virtual; /* virtual message number */
729 ENVELOPE *env; /* envelope information */
730 BODY *content; /* list of MIME parts */
736 char *tree; /* character string to print thread tree */
737 struct thread *thread;
746 int refno; /* message number on server */
749 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
750 void *data; /* driver-specific data */
753 char *maildir_flags; /* unknown maildir flags */
756 typedef struct thread {
757 unsigned int fake_thread:1;
758 unsigned int duplicate_thread:1;
759 unsigned int sort_children:1;
760 unsigned int check_subject:1;
761 unsigned int visible:1;
763 unsigned int subtree_visible:2;
764 unsigned int next_subtree_visible:1;
765 struct thread *parent;
766 struct thread *child;
774 /* flag to mutt_pattern_comp() */
775 #define M_FULL_MSG (1<<0) /* enable body and header matching */
778 M_MATCH_FULL_ADDRESS = 1
781 typedef struct pattern_t {
783 unsigned int not : 1;
784 unsigned int alladdr : 1;
785 unsigned int stringmatch : 1;
788 struct pattern_t *next;
789 struct pattern_t *child; /* arguments to logical op */
798 time_t mtime_cur; /* used with maildir folders */
801 char *pattern; /* limit pattern string */
802 pattern_t *limit_pattern; /* compiled limit pattern */
804 HEADER *last_tag; /* last tagged msg. used to link threads */
805 THREAD *tree; /* top of thread tree */
806 HASH *id_hash; /* hash table by msg id */
807 HASH *subj_hash; /* hash table by subject */
808 HASH *thread_hash; /* hash table for threading */
809 int *v2r; /* mapping from virtual to real msgno */
810 int hdrmax; /* number of pointers in hdrs */
811 int msgcount; /* number of messages in the mailbox */
812 int vcount; /* the number of virtual messages */
813 int tagged; /* how many messages are tagged? */
814 int new; /* how many new messages? */
815 int unread; /* how many unread messages? */
816 int deleted; /* how many deleted messages */
817 int appended; /* how many saved messages? */
818 int flagged; /* how many flagged messages */
819 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
820 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
821 void *data; /* driver specific data */
822 #endif /* USE_IMAP */
824 short magic; /* mailbox type */
826 #ifdef USE_COMPRESSED
827 void *compressinfo; /* compressed mbox module private data */
828 char *realpath; /* path to compressed mailbox */
829 #endif /* USE_COMPRESSED */
831 unsigned int locked:1; /* is the mailbox locked? */
832 unsigned int changed:1; /* mailbox has been modified */
833 unsigned int readonly:1; /* don't allow changes to the mailbox */
834 unsigned int dontwrite:1; /* dont write the mailbox on close */
835 unsigned int append:1; /* mailbox is opened in append mode */
836 unsigned int quiet:1; /* inhibit status messages? */
837 unsigned int collapsed:1; /* are all threads collapsed? */
838 unsigned int closing:1; /* mailbox is being closed */
839 unsigned int counting:1; /* do we just want to cound? */
842 /* for attachment counter */
850 /* Flags for mutt_count_body_parts() */
851 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
852 #define M_PARTS_RECOUNT (1<<1) /* force recount */
858 #endif /* !_MUTT_H */