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 */
211 /* Options for Mailcap lookup */
217 /* options for socket code */
223 /* Options for mutt_save_attachment */
228 /* possible arguments to set_quadoption() */
236 /* quad-option vars */
252 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
262 #if defined(USE_SSL) || defined(USE_GNUTLS)
266 OPT_VERIFYSIG, /* verify PGP signatures */
272 OPT_FOLLOWUPTOPOSTER,
273 #endif /* USE_NNTP */
275 /* THIS MUST BE THE LAST VALUE. */
279 /* flags to ci_send_message() */
280 #define SENDREPLY (1<<0)
281 #define SENDGROUPREPLY (1<<1)
282 #define SENDLISTREPLY (1<<2)
283 #define SENDFORWARD (1<<3)
284 #define SENDPOSTPONED (1<<4)
285 #define SENDBATCH (1<<5)
286 #define SENDMAILX (1<<6)
287 #define SENDKEY (1<<7)
288 #define SENDRESEND (1<<8)
289 #define SENDNEWS (1<<9)
291 /* flags to _mutt_select_file() */
292 #define M_SEL_BUFFY (1<<0)
293 #define M_SEL_MULTI (1<<1)
294 #define M_SEL_FOLDER (1<<2)
296 /* flags for parse_spam_list */
341 #endif /* HAVE_QDBM */
349 OPTHIDETHREADSUBJECT,
352 OPTIGNORELISTREPLYTO,
354 OPTIMAPCHECKSUBSCRIBED,
360 #if defined(USE_SSL) || defined(USE_GNUTLS)
364 # endif /* !USE_GNUTLS */
368 #endif /* USE_SSL || USE_GNUTLS */
377 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
379 OPTMETAKEY, /* interpret ALT-x as ESC-x */
384 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
433 #ifdef HAVE_GETADDRINFO
440 OPTWRITEBCC, /* write out a bcc header? */
442 OPTXMAILTO, /* 1 if $edit_header is forcebly set */
453 OPTCRYPTREPLYENCRYPT,
455 OPTCRYPTREPLYSIGNENCRYPTED,
459 OPTSDEFAULTDECRYPTKEY,
482 #endif /* USE_NNTP */
486 OPTAUXSORT, /* (pseudo) using auxillary sort function */
487 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
488 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
489 OPTNOCURSES, /* (pseudo) when sending in batch mode */
490 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
491 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
492 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
493 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
494 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
495 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
496 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
497 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
498 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
499 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
500 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
501 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
502 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
503 OPTATTACHMSG, /* (pseudo) used by attach-message */
504 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
505 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
506 * functions while we are executing an
509 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
510 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
511 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
512 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
513 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
516 OPTNEWS, /* (pseudo) used to change reader mode */
517 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
518 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
520 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
521 OPTSIDEBARNEWMAILONLY,
525 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
526 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
527 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
528 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
529 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
531 #define set_option(x) mutt_bit_set(Options,x)
532 #define unset_option(x) mutt_bit_unset(Options,x)
533 #define toggle_option(x) mutt_bit_toggle(Options,x)
534 #define option(x) mutt_bit_isset(Options,x)
536 typedef struct spam_list_t {
540 struct spam_list_t *next;
544 #define mutt_new_spam_list() mem_calloc (1, sizeof (SPAM_LIST))
545 void mutt_free_spam_list (SPAM_LIST **);
547 int mutt_matches_ignore (const char *, LIST *);
549 void mutt_init (int, LIST *);
551 typedef struct envelope {
552 ADDRESS *return_path;
559 ADDRESS *mail_followup_to;
560 char *list_post; /* this stores a mailto URL, or nothing */
562 char *real_subj; /* offset of the real subject */
575 LIST *references; /* message references (in reverse order) */
576 LIST *in_reply_to; /* in-reply-to header content */
577 LIST *userhdrs; /* user defined headers */
578 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
579 unsigned int refs_changed:1; /* References changed to break thread */
582 typedef struct parameter {
585 struct parameter *next;
588 /* Information that helps in determing the Content-* of an attachment */
589 typedef struct content {
590 long hibin; /* 8-bit characters */
591 long lobin; /* unprintable 7-bit chars (eg., control chars) */
592 long crlf; /* '\r' and '\n' characters */
593 long ascii; /* number of ascii chars */
594 long linemax; /* length of the longest line in the file */
595 unsigned int space:1; /* whitespace at the end of lines? */
596 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
597 unsigned int from:1; /* has a line beginning with "From "? */
598 unsigned int dot:1; /* has a line consisting of a single dot? */
599 unsigned int cr:1; /* has CR, even when in a CRLF pair */
602 typedef struct body {
603 char *xtype; /* content-type if x-unknown */
604 char *subtype; /* content-type subtype */
605 PARAMETER *parameter; /* parameters of the content-type */
606 char *description; /* content-description */
607 char *form_name; /* Content-Disposition form-data name param */
608 LOFF_T hdr_offset; /* offset in stream where the headers begin.
609 * this info is used when invoking metamail,
610 * where we need to send the headers of the
613 LOFF_T offset; /* offset where the actual data begins */
614 LOFF_T length; /* length (in bytes) of attachment */
615 char *filename; /* when sending a message, this is the file
616 * to which this structure refers
618 char *d_filename; /* filename to be used for the
619 * content-disposition header.
620 * If NULL, filename is used
623 char *file_charset; /* charset of attached file */
624 CONTENT *content; /* structure used to store detailed info about
625 * the content of the attachment. this is used
626 * to determine what content-transfer-encoding
627 * is required when sending mail.
629 struct body *next; /* next attachment in the list */
630 struct body *parts; /* parts of a multipart or message/rfc822 */
631 struct header *hdr; /* header information for message/rfc822 */
633 struct attachptr *aptr; /* Menu information, used in recvattach.c */
635 signed short attach_count;
637 time_t stamp; /* time stamp of last
641 unsigned int type:4; /* content-type primary type */
642 unsigned int encoding:3; /* content-transfer-encoding */
643 unsigned int disposition:2; /* content-disposition */
644 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
645 unsigned int unlink:1; /* flag to indicate the the file named by
646 * "filename" should be unlink()ed before
647 * free()ing this structure
649 unsigned int tagged:1;
650 unsigned int deleted:1; /* attachment marked for deletion */
652 unsigned int noconv:1; /* don't do character set conversion */
653 unsigned int force_charset:1;
654 /* send mode: don't adjust the character
655 * set when in send-mode.
657 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
658 S/MIME signed-data correctly,
659 e.g. they use foo.p7m even for
660 the name of signed data. This
661 flag is used to keep track of
662 the actual message type. It
663 gets set during the verification
664 (which is done if the encryption
665 try failed) and check by the
666 function to figure the type of
669 unsigned int goodsig:1; /* good cryptographic signature */
670 unsigned int warnsig:1; /* maybe good signature */
671 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
673 unsigned int collapsed:1; /* used by recvattach */
674 unsigned int attach_qualifies:1;
678 typedef struct header {
679 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
680 see: crypt.h pgplib.h, smime.h */
682 unsigned int mime:1; /* has a MIME-Version header? */
683 unsigned int flagged:1; /* marked important? */
684 unsigned int tagged:1;
685 unsigned int appended:1; /* has been saved */
686 unsigned int purged:1; /* bypassing the trash folder */
687 unsigned int deleted:1;
688 unsigned int changed:1;
689 unsigned int attach_del:1; /* has an attachment marked for deletion */
692 unsigned int expired:1; /* already expired? */
693 unsigned int superseded:1; /* got superseded? */
694 unsigned int replied:1;
695 unsigned int subject_changed:1; /* used for threading */
696 unsigned int threaded:1; /* used for threading */
697 unsigned int display_subject:1; /* used for threading */
698 unsigned int recip_valid:1; /* is_recipient is valid */
699 unsigned int active:1; /* message is not to be removed */
700 unsigned int trash:1; /* message is marked as trashed on disk.
701 * This flag is used by the maildir_trash
705 /* timezone of the sender of this message */
706 unsigned int zhours:5;
707 unsigned int zminutes:6;
708 unsigned int zoccident:1;
710 /* bits used for caching when searching */
711 unsigned int searched:1;
712 unsigned int matched:1;
714 /* tells whether the attach count is valid */
715 unsigned int attach_valid:1;
717 /* the following are used to support collapsing threads */
718 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
719 unsigned int limited:1; /* is this message in a limited view? */
720 size_t num_hidden; /* number of hidden messages in this view */
722 short recipient; /* user_is_recipient()'s return value, cached */
724 int pair; /* color-pair to use when displaying in the index */
726 time_t date_sent; /* time when the message was sent (UTC) */
727 time_t received; /* time when the message was placed in the mailbox */
728 LOFF_T offset; /* where in the stream does this message begin? */
729 int lines; /* how many lines in the body of this message? */
730 int index; /* the absolute (unsorted) message number */
731 int msgno; /* number displayed to the user */
732 int virtual; /* virtual message number */
734 ENVELOPE *env; /* envelope information */
735 BODY *content; /* list of MIME parts */
741 char *tree; /* character string to print thread tree */
742 struct thread *thread;
751 int refno; /* message number on server */
754 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
755 void *data; /* driver-specific data */
758 char *maildir_flags; /* unknown maildir flags */
761 typedef struct thread {
762 unsigned int fake_thread:1;
763 unsigned int duplicate_thread:1;
764 unsigned int sort_children:1;
765 unsigned int check_subject:1;
766 unsigned int visible:1;
768 unsigned int subtree_visible:2;
769 unsigned int next_subtree_visible:1;
770 struct thread *parent;
771 struct thread *child;
779 /* flag to mutt_pattern_comp() */
780 #define M_FULL_MSG (1<<0) /* enable body and header matching */
783 M_MATCH_FULL_ADDRESS = 1
786 typedef struct pattern_t {
788 unsigned int not : 1;
789 unsigned int alladdr : 1;
790 unsigned int stringmatch : 1;
793 struct pattern_t *next;
794 struct pattern_t *child; /* arguments to logical op */
803 time_t mtime_cur; /* used with maildir folders */
806 char *pattern; /* limit pattern string */
807 pattern_t *limit_pattern; /* compiled limit pattern */
809 HEADER *last_tag; /* last tagged msg. used to link threads */
810 THREAD *tree; /* top of thread tree */
811 HASH *id_hash; /* hash table by msg id */
812 HASH *subj_hash; /* hash table by subject */
813 HASH *thread_hash; /* hash table for threading */
814 int *v2r; /* mapping from virtual to real msgno */
815 int hdrmax; /* number of pointers in hdrs */
816 int msgcount; /* number of messages in the mailbox */
817 int vcount; /* the number of virtual messages */
818 int tagged; /* how many messages are tagged? */
819 int new; /* how many new messages? */
820 int unread; /* how many unread messages? */
821 int deleted; /* how many deleted messages */
822 int appended; /* how many saved messages? */
823 int flagged; /* how many flagged messages */
824 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
825 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
826 void *data; /* driver specific data */
827 #endif /* USE_IMAP */
829 short magic; /* mailbox type */
831 #ifdef USE_COMPRESSED
832 void *compressinfo; /* compressed mbox module private data */
833 char *realpath; /* path to compressed mailbox */
834 #endif /* USE_COMPRESSED */
836 unsigned int locked:1; /* is the mailbox locked? */
837 unsigned int changed:1; /* mailbox has been modified */
838 unsigned int readonly:1; /* don't allow changes to the mailbox */
839 unsigned int dontwrite:1; /* dont write the mailbox on close */
840 unsigned int append:1; /* mailbox is opened in append mode */
841 unsigned int quiet:1; /* inhibit status messages? */
842 unsigned int collapsed:1; /* are all threads collapsed? */
843 unsigned int closing:1; /* mailbox is being closed */
844 unsigned int counting:1; /* do we just want to cound? */
847 /* for attachment counter */
855 /* Flags for mutt_count_body_parts() */
856 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
857 #define M_PARTS_RECOUNT (1<<1) /* force recount */
863 #endif /* !_MUTT_H */