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>
55 # define MB_LEN_MAX 16
58 # define MUTT_VERSION (VERSION)
60 /* nifty trick I stole from ELM 2.5alpha. */
63 #define INITVAL(x) = x
69 /* flags for mutt_extract_token() */
70 #define M_TOKEN_EQUAL 1 /* treat '=' as a special */
71 #define M_TOKEN_CONDENSE (1<<1) /* ^(char) to control chars (macros) */
72 #define M_TOKEN_SPACE (1<<2) /* don't treat whitespace as a term */
73 #define M_TOKEN_QUOTE (1<<3) /* don't interpret quotes */
74 #define M_TOKEN_PATTERN (1<<4) /* !)|~ are terms (for patterns) */
75 #define M_TOKEN_COMMENT (1<<5) /* don't reap comments */
76 #define M_TOKEN_SEMICOLON (1<<6) /* don't treat ; as special */
79 int ch; /* raw key pressed */
80 int op; /* function op */
83 /* flags for _mutt_system() */
84 #define M_DETACH_PROCESS 1 /* detach subprocess from group */
86 /* flags for mutt_FormatString() */
88 M_FORMAT_FORCESUBJ = (1 << 0), /* print the subject even if unchanged */
89 M_FORMAT_TREE = (1 << 1), /* draw the thread tree */
90 M_FORMAT_MAKEPRINT = (1 << 2), /* make sure that all chars are printable */
91 M_FORMAT_OPTIONAL = (1 << 3),
92 M_FORMAT_STAT_FILE = (1 << 4), /* used by mutt_attach_fmt */
93 M_FORMAT_ARROWCURSOR = (1 << 5), /* reserve space for arrow_cursor */
94 M_FORMAT_INDEX = (1 << 6) /* this is a main index entry */
97 /* types for mutt_add_hook() */
98 #define M_FOLDERHOOK 1
99 #define M_MBOXHOOK (1<<1)
100 #define M_SENDHOOK (1<<2)
101 #define M_FCCHOOK (1<<3)
102 #define M_SAVEHOOK (1<<4)
103 #define M_CHARSETHOOK (1<<5)
104 #define M_ICONVHOOK (1<<6)
105 #define M_MESSAGEHOOK (1<<7)
106 #define M_CRYPTHOOK (1<<8)
107 #define M_ACCOUNTHOOK (1<<9)
108 #define M_REPLYHOOK (1<<10)
109 #define M_SEND2HOOK (1<<11)
111 #ifdef USE_COMPRESSED
112 #define M_OPENHOOK (1<<12)
113 #define M_APPENDHOOK (1<<13)
114 #define M_CLOSEHOOK (1<<14)
117 /* tree characters for linearize_tree and print_enriched_string */
118 #define M_TREE_LLCORNER 1
119 #define M_TREE_ULCORNER 2
120 #define M_TREE_LTEE 3
121 #define M_TREE_HLINE 4
122 #define M_TREE_VLINE 5
123 #define M_TREE_SPACE 6
124 #define M_TREE_RARROW 7
125 #define M_TREE_STAR 8
126 #define M_TREE_HIDDEN 9
127 #define M_TREE_EQUALS 10
128 #define M_TREE_TTEE 11
129 #define M_TREE_BTEE 12
130 #define M_TREE_MISSING 13
131 #define M_TREE_MAX 14
133 #define M_THREAD_COLLAPSE (1<<0)
134 #define M_THREAD_UNCOLLAPSE (1<<1)
135 #define M_THREAD_GET_HIDDEN (1<<2)
136 #define M_THREAD_UNREAD (1<<3)
137 #define M_THREAD_NEXT_UNREAD (1<<4)
140 /* modes for mutt_view_attachment() */
145 /* action codes used by mutt_set_flag() and mutt_pattern_function() */
165 /* actions for mutt_pattern_comp/mutt_pattern_exec */
205 /* Options for Mailcap lookup */
211 /* options for socket code */
217 /* Options for mutt_save_attachment */
222 /* possible arguments to set_quadoption() */
230 /* quad-option vars */
246 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
256 #if defined(USE_SSL) || defined(USE_GNUTLS)
260 OPT_VERIFYSIG, /* verify PGP signatures */
266 OPT_FOLLOWUPTOPOSTER,
267 #endif /* USE_NNTP */
269 /* THIS MUST BE THE LAST VALUE. */
273 /* flags to ci_send_message() */
274 #define SENDREPLY (1<<0)
275 #define SENDGROUPREPLY (1<<1)
276 #define SENDLISTREPLY (1<<2)
277 #define SENDFORWARD (1<<3)
278 #define SENDPOSTPONED (1<<4)
279 #define SENDBATCH (1<<5)
280 #define SENDMAILX (1<<6)
281 #define SENDKEY (1<<7)
282 #define SENDRESEND (1<<8)
283 #define SENDNEWS (1<<9)
285 /* flags to _mutt_select_file() */
286 #define M_SEL_BUFFY (1<<0)
287 #define M_SEL_MULTI (1<<1)
288 #define M_SEL_FOLDER (1<<2)
290 /* flags for parse_spam_list */
335 #endif /* HAVE_QDBM */
343 OPTHIDETHREADSUBJECT,
346 OPTIGNORELISTREPLYTO,
348 OPTIMAPCHECKSUBSCRIBED,
354 #if defined(USE_SSL) || defined(USE_GNUTLS)
358 # endif /* !USE_GNUTLS */
362 #endif /* USE_SSL || USE_GNUTLS */
371 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
373 OPTMETAKEY, /* interpret ALT-x as ESC-x */
378 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
427 #ifdef HAVE_GETADDRINFO
434 OPTWRITEBCC, /* write out a bcc header? */
436 OPTXMAILTO, /* 1 if $edit_header is forcebly set */
447 OPTCRYPTREPLYENCRYPT,
449 OPTCRYPTREPLYSIGNENCRYPTED,
453 OPTSDEFAULTDECRYPTKEY,
476 #endif /* USE_NNTP */
480 OPTAUXSORT, /* (pseudo) using auxillary sort function */
481 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
482 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
483 OPTNOCURSES, /* (pseudo) when sending in batch mode */
484 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
485 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
486 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
487 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
488 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
489 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
490 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
491 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
492 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
493 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
494 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
495 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
496 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
497 OPTATTACHMSG, /* (pseudo) used by attach-message */
498 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
499 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
500 * functions while we are executing an
503 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
504 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
505 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
506 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
507 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
510 OPTNEWS, /* (pseudo) used to change reader mode */
511 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
512 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
514 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
515 OPTSIDEBARNEWMAILONLY,
519 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
520 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
521 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
522 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
523 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
525 #define set_option(x) mutt_bit_set(Options,x)
526 #define unset_option(x) mutt_bit_unset(Options,x)
527 #define toggle_option(x) mutt_bit_toggle(Options,x)
528 #define option(x) mutt_bit_isset(Options,x)
530 typedef struct spam_list_t {
534 struct spam_list_t *next;
538 #define mutt_new_spam_list() p_new(SPAM_LIST, 1)
539 void mutt_free_spam_list (SPAM_LIST **);
541 int mutt_matches_ignore (const char *, LIST *);
543 void mutt_init (int, LIST *);
545 typedef struct envelope {
546 ADDRESS *return_path;
553 ADDRESS *mail_followup_to;
554 char *list_post; /* this stores a mailto URL, or nothing */
556 char *real_subj; /* offset of the real subject */
569 LIST *references; /* message references (in reverse order) */
570 LIST *in_reply_to; /* in-reply-to header content */
571 LIST *userhdrs; /* user defined headers */
572 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
573 unsigned int refs_changed:1; /* References changed to break thread */
576 typedef struct parameter {
579 struct parameter *next;
582 /* Information that helps in determing the Content-* of an attachment */
583 typedef struct content {
584 long hibin; /* 8-bit characters */
585 long lobin; /* unprintable 7-bit chars (eg., control chars) */
586 long crlf; /* '\r' and '\n' characters */
587 long ascii; /* number of ascii chars */
588 long linemax; /* length of the longest line in the file */
589 unsigned int space:1; /* whitespace at the end of lines? */
590 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
591 unsigned int from:1; /* has a line beginning with "From "? */
592 unsigned int dot:1; /* has a line consisting of a single dot? */
593 unsigned int cr:1; /* has CR, even when in a CRLF pair */
596 typedef struct body {
597 char *xtype; /* content-type if x-unknown */
598 char *subtype; /* content-type subtype */
599 PARAMETER *parameter; /* parameters of the content-type */
600 char *description; /* content-description */
601 char *form_name; /* Content-Disposition form-data name param */
602 off_t hdr_offset; /* offset in stream where the headers begin.
603 * this info is used when invoking metamail,
604 * where we need to send the headers of the
607 off_t offset; /* offset where the actual data begins */
608 off_t length; /* length (in bytes) of attachment */
609 char *filename; /* when sending a message, this is the file
610 * to which this structure refers
612 char *d_filename; /* filename to be used for the
613 * content-disposition header.
614 * If NULL, filename is used
617 char *file_charset; /* charset of attached file */
618 CONTENT *content; /* structure used to store detailed info about
619 * the content of the attachment. this is used
620 * to determine what content-transfer-encoding
621 * is required when sending mail.
623 struct body *next; /* next attachment in the list */
624 struct body *parts; /* parts of a multipart or message/rfc822 */
625 struct header *hdr; /* header information for message/rfc822 */
627 struct attachptr *aptr; /* Menu information, used in recvattach.c */
629 signed short attach_count;
631 time_t stamp; /* time stamp of last
635 unsigned int type:4; /* content-type primary type */
636 unsigned int encoding:3; /* content-transfer-encoding */
637 unsigned int disposition:2; /* content-disposition */
638 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
639 unsigned int unlink:1; /* flag to indicate the the file named by
640 * "filename" should be unlink()ed before
641 * free()ing this structure
643 unsigned int tagged:1;
644 unsigned int deleted:1; /* attachment marked for deletion */
646 unsigned int noconv:1; /* don't do character set conversion */
647 unsigned int force_charset:1;
648 /* send mode: don't adjust the character
649 * set when in send-mode.
651 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
652 S/MIME signed-data correctly,
653 e.g. they use foo.p7m even for
654 the name of signed data. This
655 flag is used to keep track of
656 the actual message type. It
657 gets set during the verification
658 (which is done if the encryption
659 try failed) and check by the
660 function to figure the type of
663 unsigned int goodsig:1; /* good cryptographic signature */
664 unsigned int warnsig:1; /* maybe good signature */
665 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
667 unsigned int collapsed:1; /* used by recvattach */
668 unsigned int attach_qualifies:1;
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 /* tells whether the attach count is valid */
709 unsigned int attach_valid:1;
711 /* the following are used to support collapsing threads */
712 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
713 unsigned int limited:1; /* is this message in a limited view? */
714 size_t num_hidden; /* number of hidden messages in this view */
716 short recipient; /* user_is_recipient()'s return value, cached */
718 int pair; /* color-pair to use when displaying in the index */
720 time_t date_sent; /* time when the message was sent (UTC) */
721 time_t received; /* time when the message was placed in the mailbox */
722 off_t offset; /* where in the stream does this message begin? */
723 int lines; /* how many lines in the body of this message? */
724 int index; /* the absolute (unsorted) message number */
725 int msgno; /* number displayed to the user */
726 int virtual; /* virtual message number */
728 ENVELOPE *env; /* envelope information */
729 BODY *content; /* list of MIME parts */
735 char *tree; /* character string to print thread tree */
736 struct thread *thread;
745 int refno; /* message number on server */
748 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
749 void *data; /* driver-specific data */
752 char *maildir_flags; /* unknown maildir flags */
755 typedef struct thread {
756 unsigned int fake_thread:1;
757 unsigned int duplicate_thread:1;
758 unsigned int sort_children:1;
759 unsigned int check_subject:1;
760 unsigned int visible:1;
762 unsigned int subtree_visible:2;
763 unsigned int next_subtree_visible:1;
764 struct thread *parent;
765 struct thread *child;
773 /* flag to mutt_pattern_comp() */
774 #define M_FULL_MSG (1<<0) /* enable body and header matching */
777 M_MATCH_FULL_ADDRESS = 1
780 typedef struct pattern_t {
782 unsigned int not : 1;
783 unsigned int alladdr : 1;
784 unsigned int stringmatch : 1;
787 struct pattern_t *next;
788 struct pattern_t *child; /* arguments to logical op */
797 time_t mtime_cur; /* used with maildir folders */
800 char *pattern; /* limit pattern string */
801 pattern_t *limit_pattern; /* compiled limit pattern */
803 HEADER *last_tag; /* last tagged msg. used to link threads */
804 THREAD *tree; /* top of thread tree */
805 HASH *id_hash; /* hash table by msg id */
806 HASH *subj_hash; /* hash table by subject */
807 HASH *thread_hash; /* hash table for threading */
808 int *v2r; /* mapping from virtual to real msgno */
809 int hdrmax; /* number of pointers in hdrs */
810 int msgcount; /* number of messages in the mailbox */
811 int vcount; /* the number of virtual messages */
812 int tagged; /* how many messages are tagged? */
813 int new; /* how many new messages? */
814 int unread; /* how many unread messages? */
815 int deleted; /* how many deleted messages */
816 int appended; /* how many saved messages? */
817 int flagged; /* how many flagged messages */
818 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
819 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
820 void *data; /* driver specific data */
821 #endif /* USE_IMAP */
823 short magic; /* mailbox type */
825 #ifdef USE_COMPRESSED
826 void *compressinfo; /* compressed mbox module private data */
827 char *realpath; /* path to compressed mailbox */
828 #endif /* USE_COMPRESSED */
830 unsigned int locked:1; /* is the mailbox locked? */
831 unsigned int changed:1; /* mailbox has been modified */
832 unsigned int readonly:1; /* don't allow changes to the mailbox */
833 unsigned int dontwrite:1; /* dont write the mailbox on close */
834 unsigned int append:1; /* mailbox is opened in append mode */
835 unsigned int quiet:1; /* inhibit status messages? */
836 unsigned int collapsed:1; /* are all threads collapsed? */
837 unsigned int closing:1; /* mailbox is being closed */
838 unsigned int counting:1; /* do we just want to cound? */
841 /* for attachment counter */
849 /* Flags for mutt_count_body_parts() */
850 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
851 #define M_PARTS_RECOUNT (1<<1) /* force recount */
857 #endif /* !_MUTT_H */