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>
46 #include <lib-lib/list.h>
48 #include <lib-mime/mime.h>
57 # define MB_LEN_MAX 16
60 # define MUTT_VERSION (VERSION)
62 /* nifty trick I stole from ELM 2.5alpha. */
65 #define INITVAL(x) = x
72 int ch; /* raw key pressed */
73 int op; /* function op */
76 /* flags for _mutt_system() */
77 #define M_DETACH_PROCESS 1 /* detach subprocess from group */
79 /* flags for mutt_FormatString() */
81 M_FORMAT_FORCESUBJ = (1 << 0), /* print the subject even if unchanged */
82 M_FORMAT_TREE = (1 << 1), /* draw the thread tree */
83 M_FORMAT_MAKEPRINT = (1 << 2), /* make sure that all chars are printable */
84 M_FORMAT_OPTIONAL = (1 << 3),
85 M_FORMAT_STAT_FILE = (1 << 4), /* used by mutt_attach_fmt */
86 M_FORMAT_ARROWCURSOR = (1 << 5), /* reserve space for arrow_cursor */
87 M_FORMAT_INDEX = (1 << 6) /* this is a main index entry */
90 /* types for mutt_add_hook() */
91 #define M_FOLDERHOOK 1
92 #define M_MBOXHOOK (1<<1)
93 #define M_SENDHOOK (1<<2)
94 #define M_FCCHOOK (1<<3)
95 #define M_SAVEHOOK (1<<4)
96 #define M_CHARSETHOOK (1<<5)
97 #define M_ICONVHOOK (1<<6)
98 #define M_MESSAGEHOOK (1<<7)
99 #define M_CRYPTHOOK (1<<8)
100 #define M_ACCOUNTHOOK (1<<9)
101 #define M_REPLYHOOK (1<<10)
102 #define M_SEND2HOOK (1<<11)
104 #define M_OPENHOOK (1<<12)
105 #define M_APPENDHOOK (1<<13)
106 #define M_CLOSEHOOK (1<<14)
108 /* tree characters for linearize_tree and print_enriched_string */
109 #define M_TREE_LLCORNER 1
110 #define M_TREE_ULCORNER 2
111 #define M_TREE_LTEE 3
112 #define M_TREE_HLINE 4
113 #define M_TREE_VLINE 5
114 #define M_TREE_SPACE 6
115 #define M_TREE_RARROW 7
116 #define M_TREE_STAR 8
117 #define M_TREE_HIDDEN 9
118 #define M_TREE_EQUALS 10
119 #define M_TREE_TTEE 11
120 #define M_TREE_BTEE 12
121 #define M_TREE_MISSING 13
122 #define M_TREE_MAX 14
124 #define M_THREAD_COLLAPSE (1<<0)
125 #define M_THREAD_UNCOLLAPSE (1<<1)
126 #define M_THREAD_GET_HIDDEN (1<<2)
127 #define M_THREAD_UNREAD (1<<3)
128 #define M_THREAD_NEXT_UNREAD (1<<4)
131 /* modes for mutt_view_attachment() */
136 /* action codes used by mutt_set_flag() and mutt_pattern_function() */
156 /* actions for mutt_pattern_comp/mutt_pattern_exec */
196 /* Options for Mailcap lookup */
202 /* options for socket code */
208 /* Options for mutt_save_attachment */
213 /* possible arguments to set_quadoption() */
221 /* quad-option vars */
237 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
245 #if defined(USE_SSL) || defined(USE_GNUTLS)
249 OPT_VERIFYSIG, /* verify PGP signatures */
255 OPT_FOLLOWUPTOPOSTER,
256 #endif /* USE_NNTP */
258 /* THIS MUST BE THE LAST VALUE. */
262 /* flags to ci_send_message() */
263 #define SENDREPLY (1<<0)
264 #define SENDGROUPREPLY (1<<1)
265 #define SENDLISTREPLY (1<<2)
266 #define SENDFORWARD (1<<3)
267 #define SENDPOSTPONED (1<<4)
268 #define SENDBATCH (1<<5)
269 #define SENDMAILX (1<<6)
270 #define SENDKEY (1<<7)
271 #define SENDRESEND (1<<8)
272 #define SENDNEWS (1<<9)
274 /* flags to _mutt_select_file() */
275 #define M_SEL_BUFFY (1<<0)
276 #define M_SEL_MULTI (1<<1)
277 #define M_SEL_FOLDER (1<<2)
279 /* flags for parse_spam_list */
324 #endif /* HAVE_QDBM */
332 OPTHIDETHREADSUBJECT,
335 OPTIGNORELISTREPLYTO,
337 OPTIMAPCHECKSUBSCRIBED,
343 #if defined(USE_SSL) || defined(USE_GNUTLS)
347 # endif /* !USE_GNUTLS */
351 #endif /* USE_SSL || USE_GNUTLS */
360 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
362 OPTMETAKEY, /* interpret ALT-x as ESC-x */
367 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
414 #ifdef HAVE_GETADDRINFO
421 OPTWRITEBCC, /* write out a bcc header? */
423 OPTXMAILTO, /* 1 if $edit_header is forcebly set */
434 OPTCRYPTREPLYENCRYPT,
436 OPTCRYPTREPLYSIGNENCRYPTED,
440 OPTSDEFAULTDECRYPTKEY,
463 #endif /* USE_NNTP */
467 OPTAUXSORT, /* (pseudo) using auxillary sort function */
468 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
469 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
470 OPTNOCURSES, /* (pseudo) when sending in batch mode */
471 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
472 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
473 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
474 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
475 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
476 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
477 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
478 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
479 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
480 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
481 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
482 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
483 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
484 OPTATTACHMSG, /* (pseudo) used by attach-message */
485 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
486 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
487 * functions while we are executing an
490 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
491 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
492 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
493 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
494 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
497 OPTNEWS, /* (pseudo) used to change reader mode */
498 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
499 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
501 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
502 OPTSIDEBARNEWMAILONLY,
506 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
507 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
508 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
509 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
510 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
512 #define set_option(x) mutt_bit_set(Options,x)
513 #define unset_option(x) mutt_bit_unset(Options,x)
514 #define toggle_option(x) mutt_bit_toggle(Options,x)
515 #define option(x) mutt_bit_isset(Options,x)
517 typedef struct spam_list_t {
521 struct spam_list_t *next;
525 #define mutt_new_spam_list() p_new(SPAM_LIST, 1)
526 void mutt_free_spam_list (SPAM_LIST **);
528 int mutt_matches_ignore (const char *, LIST *);
530 void mutt_init (int, LIST *);
532 /* Information that helps in determing the Content-* of an attachment */
533 typedef struct content {
534 long hibin; /* 8-bit characters */
535 long lobin; /* unprintable 7-bit chars (eg., control chars) */
536 long crlf; /* '\r' and '\n' characters */
537 long ascii; /* number of ascii chars */
538 long linemax; /* length of the longest line in the file */
539 unsigned int space:1; /* whitespace at the end of lines? */
540 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
541 unsigned int from:1; /* has a line beginning with "From "? */
542 unsigned int dot:1; /* has a line consisting of a single dot? */
543 unsigned int cr:1; /* has CR, even when in a CRLF pair */
546 typedef struct body {
547 char *xtype; /* content-type if x-unknown */
548 char *subtype; /* content-type subtype */
549 PARAMETER *parameter; /* parameters of the content-type */
550 char *description; /* content-description */
551 char *form_name; /* Content-Disposition form-data name param */
552 off_t hdr_offset; /* offset in stream where the headers begin.
553 * this info is used when invoking metamail,
554 * where we need to send the headers of the
557 off_t offset; /* offset where the actual data begins */
558 off_t length; /* length (in bytes) of attachment */
559 char *filename; /* when sending a message, this is the file
560 * to which this structure refers
562 char *d_filename; /* filename to be used for the
563 * content-disposition header.
564 * If NULL, filename is used
567 char *file_charset; /* charset of attached file */
568 CONTENT *content; /* structure used to store detailed info about
569 * the content of the attachment. this is used
570 * to determine what content-transfer-encoding
571 * is required when sending mail.
573 struct body *next; /* next attachment in the list */
574 struct body *parts; /* parts of a multipart or message/rfc822 */
575 struct header *hdr; /* header information for message/rfc822 */
577 struct attachptr *aptr; /* Menu information, used in recvattach.c */
579 signed short attach_count;
581 time_t stamp; /* time stamp of last
585 unsigned int type:4; /* content-type primary type */
586 unsigned int encoding:3; /* content-transfer-encoding */
587 unsigned int disposition:2; /* content-disposition */
588 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
589 unsigned int unlink:1; /* flag to indicate the the file named by
590 * "filename" should be unlink()ed before
591 * free()ing this structure
593 unsigned int tagged:1;
594 unsigned int deleted:1; /* attachment marked for deletion */
596 unsigned int noconv:1; /* don't do character set conversion */
597 unsigned int force_charset:1;
598 /* send mode: don't adjust the character
599 * set when in send-mode.
601 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
602 S/MIME signed-data correctly,
603 e.g. they use foo.p7m even for
604 the name of signed data. This
605 flag is used to keep track of
606 the actual message type. It
607 gets set during the verification
608 (which is done if the encryption
609 try failed) and check by the
610 function to figure the type of
613 unsigned int goodsig:1; /* good cryptographic signature */
614 unsigned int warnsig:1; /* maybe good signature */
615 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
617 unsigned int collapsed:1; /* used by recvattach */
618 unsigned int attach_qualifies:1;
622 typedef struct header {
623 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
624 see: crypt.h pgplib.h, smime.h */
626 unsigned int mime:1; /* has a MIME-Version header? */
627 unsigned int flagged:1; /* marked important? */
628 unsigned int tagged:1;
629 unsigned int appended:1; /* has been saved */
630 unsigned int purged:1; /* bypassing the trash folder */
631 unsigned int deleted:1;
632 unsigned int changed:1;
633 unsigned int attach_del:1; /* has an attachment marked for deletion */
636 unsigned int expired:1; /* already expired? */
637 unsigned int superseded:1; /* got superseded? */
638 unsigned int replied:1;
639 unsigned int subject_changed:1; /* used for threading */
640 unsigned int threaded:1; /* used for threading */
641 unsigned int display_subject:1; /* used for threading */
642 unsigned int recip_valid:1; /* is_recipient is valid */
643 unsigned int active:1; /* message is not to be removed */
644 unsigned int trash:1; /* message is marked as trashed on disk.
645 * This flag is used by the maildir_trash
649 /* timezone of the sender of this message */
650 unsigned int zhours:5;
651 unsigned int zminutes:6;
652 unsigned int zoccident:1;
654 /* bits used for caching when searching */
655 unsigned int searched:1;
656 unsigned int matched:1;
658 /* tells whether the attach count is valid */
659 unsigned int attach_valid:1;
661 /* the following are used to support collapsing threads */
662 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
663 unsigned int limited:1; /* is this message in a limited view? */
664 size_t num_hidden; /* number of hidden messages in this view */
666 short recipient; /* user_is_recipient()'s return value, cached */
668 int pair; /* color-pair to use when displaying in the index */
670 time_t date_sent; /* time when the message was sent (UTC) */
671 time_t received; /* time when the message was placed in the mailbox */
672 off_t offset; /* where in the stream does this message begin? */
673 int lines; /* how many lines in the body of this message? */
674 int index; /* the absolute (unsorted) message number */
675 int msgno; /* number displayed to the user */
676 int virtual; /* virtual message number */
678 ENVELOPE *env; /* envelope information */
679 BODY *content; /* list of MIME parts */
685 char *tree; /* character string to print thread tree */
686 struct thread *thread;
694 int refno; /* message number on server */
695 void *data; /* driver-specific data */
697 char *maildir_flags; /* unknown maildir flags */
700 typedef struct thread {
701 unsigned int fake_thread:1;
702 unsigned int duplicate_thread:1;
703 unsigned int sort_children:1;
704 unsigned int check_subject:1;
705 unsigned int visible:1;
707 unsigned int subtree_visible:2;
708 unsigned int next_subtree_visible:1;
709 struct thread *parent;
710 struct thread *child;
718 /* flag to mutt_pattern_comp() */
719 #define M_FULL_MSG (1<<0) /* enable body and header matching */
722 M_MATCH_FULL_ADDRESS = 1
725 typedef struct pattern_t {
727 unsigned int not : 1;
728 unsigned int alladdr : 1;
729 unsigned int stringmatch : 1;
732 struct pattern_t *next;
733 struct pattern_t *child; /* arguments to logical op */
742 time_t mtime_cur; /* used with maildir folders */
745 char *pattern; /* limit pattern string */
746 pattern_t *limit_pattern; /* compiled limit pattern */
748 HEADER *last_tag; /* last tagged msg. used to link threads */
749 THREAD *tree; /* top of thread tree */
750 HASH *id_hash; /* hash table by msg id */
751 HASH *subj_hash; /* hash table by subject */
752 HASH *thread_hash; /* hash table for threading */
753 int *v2r; /* mapping from virtual to real msgno */
754 int hdrmax; /* number of pointers in hdrs */
755 int msgcount; /* number of messages in the mailbox */
756 int vcount; /* the number of virtual messages */
757 int tagged; /* how many messages are tagged? */
758 int new; /* how many new messages? */
759 int unread; /* how many unread messages? */
760 int deleted; /* how many deleted messages */
761 int appended; /* how many saved messages? */
762 int flagged; /* how many flagged messages */
763 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
764 void *data; /* driver specific data */
766 short magic; /* mailbox type */
768 void *compressinfo; /* compressed mbox module private data */
769 char *realpath; /* path to compressed mailbox */
771 unsigned int locked:1; /* is the mailbox locked? */
772 unsigned int changed:1; /* mailbox has been modified */
773 unsigned int readonly:1; /* don't allow changes to the mailbox */
774 unsigned int dontwrite:1; /* dont write the mailbox on close */
775 unsigned int append:1; /* mailbox is opened in append mode */
776 unsigned int quiet:1; /* inhibit status messages? */
777 unsigned int collapsed:1; /* are all threads collapsed? */
778 unsigned int closing:1; /* mailbox is being closed */
779 unsigned int counting:1; /* do we just want to cound? */
782 /* for attachment counter */
790 /* Flags for mutt_count_body_parts() */
791 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
792 #define M_PARTS_RECOUNT (1<<1) /* force recount */
798 #endif /* !_MUTT_H */