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 */
235 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
243 #if defined(USE_SSL) || defined(USE_GNUTLS)
247 OPT_VERIFYSIG, /* verify PGP signatures */
253 OPT_FOLLOWUPTOPOSTER,
254 #endif /* USE_NNTP */
256 /* THIS MUST BE THE LAST VALUE. */
260 /* flags to ci_send_message() */
261 #define SENDREPLY (1<<0)
262 #define SENDGROUPREPLY (1<<1)
263 #define SENDLISTREPLY (1<<2)
264 #define SENDFORWARD (1<<3)
265 #define SENDPOSTPONED (1<<4)
266 #define SENDBATCH (1<<5)
267 #define SENDMAILX (1<<6)
268 #define SENDKEY (1<<7)
269 #define SENDRESEND (1<<8)
270 #define SENDNEWS (1<<9)
272 /* flags to _mutt_select_file() */
273 #define M_SEL_BUFFY (1<<0)
274 #define M_SEL_MULTI (1<<1)
275 #define M_SEL_FOLDER (1<<2)
277 /* flags for parse_spam_list */
322 #endif /* HAVE_QDBM */
330 OPTHIDETHREADSUBJECT,
333 OPTIGNORELISTREPLYTO,
334 OPTIMAPCHECKSUBSCRIBED,
339 #if defined(USE_SSL) || defined(USE_GNUTLS)
343 # endif /* !USE_GNUTLS */
347 #endif /* USE_SSL || USE_GNUTLS */
356 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
358 OPTMETAKEY, /* interpret ALT-x as ESC-x */
363 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
410 #ifdef HAVE_GETADDRINFO
417 OPTWRITEBCC, /* write out a bcc header? */
419 OPTXMAILTO, /* 1 if $edit_header is forcebly set */
430 OPTCRYPTREPLYENCRYPT,
432 OPTCRYPTREPLYSIGNENCRYPTED,
436 OPTSDEFAULTDECRYPTKEY,
459 #endif /* USE_NNTP */
463 OPTAUXSORT, /* (pseudo) using auxillary sort function */
464 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
465 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
466 OPTNOCURSES, /* (pseudo) when sending in batch mode */
467 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
468 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
469 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
470 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
471 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
472 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
473 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
474 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
475 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
476 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
477 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
478 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
479 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
480 OPTATTACHMSG, /* (pseudo) used by attach-message */
481 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
482 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
483 * functions while we are executing an
486 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
487 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
488 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
489 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
490 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
493 OPTNEWS, /* (pseudo) used to change reader mode */
494 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
495 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
497 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
498 OPTSIDEBARNEWMAILONLY,
502 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
503 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
504 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
505 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
506 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
508 #define set_option(x) mutt_bit_set(Options,x)
509 #define unset_option(x) mutt_bit_unset(Options,x)
510 #define toggle_option(x) mutt_bit_toggle(Options,x)
511 #define option(x) mutt_bit_isset(Options,x)
513 typedef struct spam_list_t {
517 struct spam_list_t *next;
521 #define mutt_new_spam_list() p_new(SPAM_LIST, 1)
522 void mutt_free_spam_list (SPAM_LIST **);
524 int mutt_matches_ignore (const char *, LIST *);
526 void mutt_init (int, LIST *);
528 /* Information that helps in determing the Content-* of an attachment */
529 typedef struct content {
530 long hibin; /* 8-bit characters */
531 long lobin; /* unprintable 7-bit chars (eg., control chars) */
532 long crlf; /* '\r' and '\n' characters */
533 long ascii; /* number of ascii chars */
534 long linemax; /* length of the longest line in the file */
535 unsigned int space:1; /* whitespace at the end of lines? */
536 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
537 unsigned int from:1; /* has a line beginning with "From "? */
538 unsigned int dot:1; /* has a line consisting of a single dot? */
539 unsigned int cr:1; /* has CR, even when in a CRLF pair */
542 typedef struct body {
543 char *xtype; /* content-type if x-unknown */
544 char *subtype; /* content-type subtype */
545 PARAMETER *parameter; /* parameters of the content-type */
546 char *description; /* content-description */
547 char *form_name; /* Content-Disposition form-data name param */
548 off_t hdr_offset; /* offset in stream where the headers begin.
549 * this info is used when invoking metamail,
550 * where we need to send the headers of the
553 off_t offset; /* offset where the actual data begins */
554 off_t length; /* length (in bytes) of attachment */
555 char *filename; /* when sending a message, this is the file
556 * to which this structure refers
558 char *d_filename; /* filename to be used for the
559 * content-disposition header.
560 * If NULL, filename is used
563 char *file_charset; /* charset of attached file */
564 CONTENT *content; /* structure used to store detailed info about
565 * the content of the attachment. this is used
566 * to determine what content-transfer-encoding
567 * is required when sending mail.
569 struct body *next; /* next attachment in the list */
570 struct body *parts; /* parts of a multipart or message/rfc822 */
571 struct header *hdr; /* header information for message/rfc822 */
573 struct attachptr *aptr; /* Menu information, used in recvattach.c */
575 signed short attach_count;
577 time_t stamp; /* time stamp of last
581 unsigned int type:4; /* content-type primary type */
582 unsigned int encoding:3; /* content-transfer-encoding */
583 unsigned int disposition:2; /* content-disposition */
584 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
585 unsigned int unlink:1; /* flag to indicate the the file named by
586 * "filename" should be unlink()ed before
587 * free()ing this structure
589 unsigned int tagged:1;
590 unsigned int deleted:1; /* attachment marked for deletion */
592 unsigned int noconv:1; /* don't do character set conversion */
593 unsigned int force_charset:1;
594 /* send mode: don't adjust the character
595 * set when in send-mode.
597 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
598 S/MIME signed-data correctly,
599 e.g. they use foo.p7m even for
600 the name of signed data. This
601 flag is used to keep track of
602 the actual message type. It
603 gets set during the verification
604 (which is done if the encryption
605 try failed) and check by the
606 function to figure the type of
609 unsigned int goodsig:1; /* good cryptographic signature */
610 unsigned int warnsig:1; /* maybe good signature */
611 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
613 unsigned int collapsed:1; /* used by recvattach */
614 unsigned int attach_qualifies:1;
618 typedef struct header {
619 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
620 see: crypt.h pgplib.h, smime.h */
622 unsigned int mime:1; /* has a MIME-Version header? */
623 unsigned int flagged:1; /* marked important? */
624 unsigned int tagged:1;
625 unsigned int appended:1; /* has been saved */
626 unsigned int purged:1; /* bypassing the trash folder */
627 unsigned int deleted:1;
628 unsigned int changed:1;
629 unsigned int attach_del:1; /* has an attachment marked for deletion */
632 unsigned int expired:1; /* already expired? */
633 unsigned int superseded:1; /* got superseded? */
634 unsigned int replied:1;
635 unsigned int subject_changed:1; /* used for threading */
636 unsigned int threaded:1; /* used for threading */
637 unsigned int display_subject:1; /* used for threading */
638 unsigned int recip_valid:1; /* is_recipient is valid */
639 unsigned int active:1; /* message is not to be removed */
640 unsigned int trash:1; /* message is marked as trashed on disk.
641 * This flag is used by the maildir_trash
645 /* timezone of the sender of this message */
646 unsigned int zhours:5;
647 unsigned int zminutes:6;
648 unsigned int zoccident:1;
650 /* bits used for caching when searching */
651 unsigned int searched:1;
652 unsigned int matched:1;
654 /* tells whether the attach count is valid */
655 unsigned int attach_valid:1;
657 /* the following are used to support collapsing threads */
658 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
659 unsigned int limited:1; /* is this message in a limited view? */
660 size_t num_hidden; /* number of hidden messages in this view */
662 short recipient; /* user_is_recipient()'s return value, cached */
664 int pair; /* color-pair to use when displaying in the index */
666 time_t date_sent; /* time when the message was sent (UTC) */
667 time_t received; /* time when the message was placed in the mailbox */
668 off_t offset; /* where in the stream does this message begin? */
669 int lines; /* how many lines in the body of this message? */
670 int index; /* the absolute (unsorted) message number */
671 int msgno; /* number displayed to the user */
672 int virtual; /* virtual message number */
674 ENVELOPE *env; /* envelope information */
675 BODY *content; /* list of MIME parts */
681 char *tree; /* character string to print thread tree */
682 struct thread *thread;
690 int refno; /* message number on server */
691 void *data; /* driver-specific data */
693 char *maildir_flags; /* unknown maildir flags */
696 typedef struct thread {
697 unsigned int fake_thread:1;
698 unsigned int duplicate_thread:1;
699 unsigned int sort_children:1;
700 unsigned int check_subject:1;
701 unsigned int visible:1;
703 unsigned int subtree_visible:2;
704 unsigned int next_subtree_visible:1;
705 struct thread *parent;
706 struct thread *child;
714 /* flag to mutt_pattern_comp() */
715 #define M_FULL_MSG (1<<0) /* enable body and header matching */
718 M_MATCH_FULL_ADDRESS = 1
721 typedef struct pattern_t {
723 unsigned int not : 1;
724 unsigned int alladdr : 1;
725 unsigned int stringmatch : 1;
728 struct pattern_t *next;
729 struct pattern_t *child; /* arguments to logical op */
738 time_t mtime_cur; /* used with maildir folders */
741 char *pattern; /* limit pattern string */
742 pattern_t *limit_pattern; /* compiled limit pattern */
744 HEADER *last_tag; /* last tagged msg. used to link threads */
745 THREAD *tree; /* top of thread tree */
746 HASH *id_hash; /* hash table by msg id */
747 HASH *subj_hash; /* hash table by subject */
748 HASH *thread_hash; /* hash table for threading */
749 int *v2r; /* mapping from virtual to real msgno */
750 int hdrmax; /* number of pointers in hdrs */
751 int msgcount; /* number of messages in the mailbox */
752 int vcount; /* the number of virtual messages */
753 int tagged; /* how many messages are tagged? */
754 int new; /* how many new messages? */
755 int unread; /* how many unread messages? */
756 int deleted; /* how many deleted messages */
757 int appended; /* how many saved messages? */
758 int flagged; /* how many flagged messages */
759 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
760 void *data; /* driver specific data */
762 short magic; /* mailbox type */
764 void *compressinfo; /* compressed mbox module private data */
765 char *realpath; /* path to compressed mailbox */
767 unsigned int locked:1; /* is the mailbox locked? */
768 unsigned int changed:1; /* mailbox has been modified */
769 unsigned int readonly:1; /* don't allow changes to the mailbox */
770 unsigned int dontwrite:1; /* dont write the mailbox on close */
771 unsigned int append:1; /* mailbox is opened in append mode */
772 unsigned int quiet:1; /* inhibit status messages? */
773 unsigned int collapsed:1; /* are all threads collapsed? */
774 unsigned int closing:1; /* mailbox is being closed */
775 unsigned int counting:1; /* do we just want to cound? */
778 /* for attachment counter */
786 /* Flags for mutt_count_body_parts() */
787 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
788 #define M_PARTS_RECOUNT (1<<1) /* force recount */
794 #endif /* !_MUTT_H */