mutt.h

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
   4  * Copyright (C) 2004 g10 Code GmbH
   5  *
   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.
   9  */
  10
  11 #ifndef _MUTT_H
  12 #define _MUTT_H
  13
  14 #include <lib-lib/lib-lib.h>
  15 #include <lib-mime/mime.h>
  16 #include <lib-lua/lib-lua.h>
  17
  18 #define MUTT_VERSION (VERSION)
  19
  20 /* nifty trick I stole from ELM 2.5alpha. */
  21 #ifdef MAIN_C
  22 #define WHERE
  23 #define INITVAL(x) = x
  24 #else
  25 #define WHERE extern
  26 #define INITVAL(x)
  27 #endif
  28
  29 typedef struct {
  30   int ch;                       /* raw key pressed */
  31   int op;                       /* function op */
  32 } event_t;
  33
  34 /* types for mutt_add_hook() */
  35 #define M_FOLDERHOOK    1
  36 #define M_MBOXHOOK      (1<<1)
  37 #define M_SENDHOOK      (1<<2)
  38 #define M_FCCHOOK       (1<<3)
  39 #define M_SAVEHOOK      (1<<4)
  40 #define M_MESSAGEHOOK   (1<<5)
  41 #define M_CRYPTHOOK     (1<<6)
  42 #define M_ACCOUNTHOOK   (1<<7)
  43 #define M_REPLYHOOK     (1<<8)
  44 #define M_SEND2HOOK     (1<<9)
  45
  46 #define M_OPENHOOK      (1<<10)
  47 #define M_APPENDHOOK    (1<<11)
  48 #define M_CLOSEHOOK     (1<<12)
  49
  50 /* tree characters for linearize_tree and print_enriched_string */
  51 #define M_TREE_LLCORNER         1
  52 #define M_TREE_ULCORNER         2
  53 #define M_TREE_LTEE             3
  54 #define M_TREE_HLINE            4
  55 #define M_TREE_VLINE            5
  56 #define M_TREE_SPACE            6
  57 #define M_TREE_RARROW           7
  58 #define M_TREE_STAR             8
  59 #define M_TREE_HIDDEN           9
  60 #define M_TREE_EQUALS           10
  61 #define M_TREE_TTEE             11
  62 #define M_TREE_BTEE             12
  63 #define M_TREE_MISSING          13
  64 #define M_TREE_MAX              14
  65
  66 #define M_THREAD_COLLAPSE       (1<<0)
  67 #define M_THREAD_UNCOLLAPSE     (1<<1)
  68 #define M_THREAD_GET_HIDDEN     (1<<2)
  69 #define M_THREAD_UNREAD         (1<<3)
  70 #define M_THREAD_NEXT_UNREAD    (1<<4)
  71
  72 enum {
  73   /* modes for mutt_view_attachment() */
  74   M_REGULAR = 1,
  75   M_MAILCAP,
  76   M_AS_TEXT,
  77
  78   /* action codes used by mutt_set_flag() and mutt_pattern_function() */
  79   M_ALL,
  80   M_NONE,
  81   M_NEW,
  82   M_OLD,
  83   M_REPLIED,
  84   M_READ,
  85   M_UNREAD,
  86   M_DELETE,
  87   M_UNDELETE,
  88   M_DELETED,
  89   M_APPENDED,
  90   M_PURGED,
  91   M_FLAG,
  92   M_TAG,
  93   M_UNTAG,
  94   M_LIMIT,
  95   M_EXPIRED,
  96   M_SUPERSEDED,
  97
  98   /* actions for mutt_pattern_comp/mutt_pattern_exec */
  99   M_AND,
 100   M_OR,
 101   M_TO,
 102   M_CC,
 103   M_COLLAPSED,
 104   M_SUBJECT,
 105   M_FROM,
 106   M_DATE,
 107   M_DATE_RECEIVED,
 108   M_DUPLICATED,
 109   M_UNREFERENCED,
 110   M_ID,
 111   M_BODY,
 112   M_HEADER,
 113   M_HORMEL,
 114   M_WHOLE_MSG,
 115   M_SENDER,
 116   M_MESSAGE,
 117   M_SCORE,
 118   M_SIZE,
 119   M_REFERENCE,
 120   M_RECIPIENT,
 121   M_LIST,
 122   M_SUBSCRIBED_LIST,
 123   M_PERSONAL_RECIP,
 124   M_PERSONAL_FROM,
 125   M_ADDRESS,
 126   M_CRYPT_SIGN,
 127   M_CRYPT_VERIFIED,
 128   M_CRYPT_ENCRYPT,
 129   M_PGP_KEY,
 130   M_XLABEL,
 131   M_MIMEATTACH,
 132 #ifdef USE_NNTP
 133   M_NEWSGROUPS,
 134 #endif
 135   M_REALNAME,
 136   M_MULTIPART,
 137
 138   /* Options for Mailcap lookup */
 139   M_EDIT,
 140   M_COMPOSE,
 141   M_PRINT,
 142   M_AUTOVIEW,
 143
 144   /* options for socket code */
 145   M_NEW_SOCKET,
 146
 147   /* Options for mutt_save_attachment */
 148   M_SAVE_APPEND,
 149   M_SAVE_OVERWRITE
 150 };
 151
 152 /* quad-option vars */
 153 enum {
 154   OPT_ABORT,
 155   OPT_ATTACH,
 156   OPT_BOUNCE,
 157   OPT_COPY,
 158   OPT_DELETE,
 159   OPT_FORWEDIT,
 160   OPT_INCLUDE,
 161   OPT_IMAPRECONNECT,
 162   OPT_MFUPTO,
 163   OPT_MIMEFWD,
 164   OPT_MIMEFWDREST,
 165   OPT_MOVE,
 166   OPT_POPDELETE,
 167   OPT_POPRECONNECT,
 168   OPT_POSTPONE,
 169   OPT_PRINT,
 170   OPT_REPLYTO,
 171   OPT_RECALL,
 172   OPT_SSLSTARTTLS,
 173   OPT_SUBJECT,
 174   OPT_VERIFYSIG,                /* verify PGP signatures */
 175   OPT_LISTREPLY,
 176 #ifdef USE_NNTP
 177   OPT_TOMODERATED,
 178   OPT_NNTPRECONNECT,
 179   OPT_CATCHUP,
 180   OPT_FOLLOWUPTOPOSTER,
 181 #endif                          /* USE_NNTP */
 182
 183   /* THIS MUST BE THE LAST VALUE. */
 184   OPT_MAX
 185 };
 186
 187 /* flags to ci_send_message() */
 188 #define SENDREPLY       (1<<0)
 189 #define SENDGROUPREPLY  (1<<1)
 190 #define SENDLISTREPLY   (1<<2)
 191 #define SENDFORWARD     (1<<3)
 192 #define SENDPOSTPONED   (1<<4)
 193 #define SENDBATCH       (1<<5)
 194 #define SENDRESEND      (1<<6)
 195 #define SENDNEWS        (1<<7)
 196
 197 /* flags to _mutt_select_file() */
 198 #define M_SEL_BUFFY     (1<<0)
 199 #define M_SEL_MULTI     (1<<1)
 200 #define M_SEL_FOLDER    (1<<2)
 201
 202 /* boolean vars */
 203 enum {
 204   OPTALLOW8BIT,
 205   OPTALLOWANSI,
 206   OPTARROWCURSOR,
 207   OPTASCIICHARS,
 208   OPTASKBCC,
 209   OPTASKCC,
 210   OPTASKFOLLOWUP,
 211   OPTASKXCOMMENTTO,
 212   OPTATTACHSPLIT,
 213   OPTAUTOEDIT,
 214   OPTAUTOTAG,
 215   OPTBOUNCEDELIVERED,
 216   OPTBRAILLEFRIENDLY,
 217   OPTCHECKNEW,
 218   OPTCOLLAPSEUNREAD,
 219   OPTCONFIRMAPPEND,
 220   OPTCONFIRMCREATE,
 221   OPTDELETEUNTAG,
 222   OPTDELSP,
 223   OPTDIGESTCOLLAPSE,
 224   OPTDUPTHREADS,
 225   OPTEDITHDRS,
 226   OPTENCODEFROM,
 227   OPTFASTREPLY,
 228   OPTFCCATTACH,
 229   OPTFCCCLEAR,
 230   OPTFOLLOWUPTO,
 231   OPTFORCEBUFFYCHECK,
 232   OPTFORCENAME,
 233   OPTFORWDECODE,
 234   OPTFORWQUOTE,
 235 #ifdef USE_HCACHE
 236   OPTHCACHEVERIFY,
 237 #ifdef HAVE_QDBM
 238   OPTHCACHECOMPRESS,
 239 #endif /* HAVE_QDBM */
 240 #endif
 241   OPTHDRS,
 242   OPTHEADER,
 243   OPTHELP,
 244   OPTHIDDENHOST,
 245   OPTHIDELIMITED,
 246   OPTHIDEMISSING,
 247   OPTHIDETHREADSUBJECT,
 248   OPTHIDETOPLIMITED,
 249   OPTHIDETOPMISSING,
 250   OPTIGNORELISTREPLYTO,
 251   OPTIMAPCHECKSUBSCRIBED,
 252   OPTIMAPLSUB,
 253   OPTIMAPPASSIVE,
 254   OPTIMAPPEEK,
 255   OPTIMAPSERVERNOISE,
 256   OPTSSLV3,
 257   OPTTLSV1,
 258   OPTSSLFORCETLS,
 259   OPTIMPLICITAUTOVIEW,
 260   OPTINCLUDEONLYFIRST,
 261   OPTKEEPFLAGGED,
 262   OPTMAILDIRTRASH,
 263   OPTMARKERS,
 264   OPTMARKOLD,
 265   OPTMBOXPANE,
 266   OPTMENUSCROLL,                /* scroll menu instead of implicit next-page */
 267   OPTMENUMOVEOFF,
 268   OPTMETAKEY,                   /* interpret ALT-x as ESC-x */
 269   OPTMETOO,
 270   OPTMHPURGE,
 271   OPTMIMEFORWDECODE,
 272   OPTNARROWTREE,
 273   OPTPAGERSTOP,
 274   OPTPIPEDECODE,
 275   OPTPIPESPLIT,
 276   OPTPOPAUTHTRYALL,
 277   OPTPOPLAST,
 278   OPTPRINTDECODE,
 279   OPTPRINTSPLIT,
 280   OPTPROMPTAFTER,
 281   OPTQUOTEEMPTY,
 282   OPTQUOTEQUOTED,
 283   OPTREADONLY,
 284   OPTREPLYSELF,
 285   OPTRESOLVE,
 286   OPTREVALIAS,
 287   OPTREVNAME,
 288   OPTREVREAL,
 289   OPTSAVEADDRESS,
 290   OPTSAVEEMPTY,
 291   OPTSAVENAME,
 292   OPTSCORE,
 293   OPTSIGDASHES,
 294   OPTSORTRE,
 295   OPTSPAMSEP,
 296   OPTSTATUSONTOP,
 297   OPTSTRICTMAILTO,
 298   OPTSTRICTTHREADS,
 299   OPTSTRIPWAS,
 300   OPTSTUFFQUOTED,
 301   OPTSUSPEND,
 302   OPTTEXTFLOWED,
 303   OPTTHOROUGHSRC,
 304   OPTTHREADRECEIVED,
 305   OPTTILDE,
 306   OPTUNCOLLAPSEJUMP,
 307   OPTUSEFROM,
 308 #ifdef HAVE_LIBIDN
 309   OPTUSEIDN,
 310 #endif
 311 #ifdef HAVE_GETADDRINFO
 312   OPTUSEIPV6,
 313 #endif
 314   OPTWAITKEY,
 315   OPTWEED,
 316   OPTWRAP,
 317   OPTWRAPSEARCH,
 318   OPTWRITEBCC,                  /* write out a bcc header? */
 319   OPTXMAILER,
 320   OPTXMAILTO,                   /* 1 if $edit_header is forcebly set */
 321   OPTXTERMSETTITLES,
 322
 323   /* PGP options */
 324
 325   OPTCRYPTAUTOSIGN,
 326   OPTCRYPTAUTOENCRYPT,
 327   OPTCRYPTAUTOPGP,
 328   OPTCRYPTAUTOSMIME,
 329   OPTCRYPTREPLYENCRYPT,
 330   OPTCRYPTREPLYSIGN,
 331   OPTCRYPTREPLYSIGNENCRYPTED,
 332   OPTSMIMEISDEFAULT,
 333   OPTPGPAUTODEC,
 334   OPTPGPRETAINABLESIG,
 335   OPTFORWDECRYPT,
 336   OPTPGPSHOWUNUSABLE,
 337
 338   /* news options */
 339
 340 #ifdef USE_NNTP
 341   OPTSHOWNEWNEWS,
 342   OPTSHOWONLYUNREAD,
 343   OPTSAVEUNSUB,
 344   OPTLOADDESC,
 345   OPTXCOMMENTTO,
 346 #endif                          /* USE_NNTP */
 347
 348   /* pseudo options */
 349
 350   OPTAUXSORT,                   /* (pseudo) using auxillary sort function */
 351   OPTFORCEREFRESH,              /* (pseudo) refresh even during macros */
 352   OPTNOCURSES,                  /* (pseudo) when sending in batch mode */
 353   OPTNEEDREDRAW,                /* (pseudo) to notify caller of a submenu */
 354   OPTSEARCHREVERSE,             /* (pseudo) used by ci_search_command */
 355   OPTMSGERR,                    /* (pseudo) used by mutt_error/mutt_message */
 356   OPTSEARCHINVALID,             /* (pseudo) used to invalidate the search pat */
 357   OPTSIGNALSBLOCKED,            /* (pseudo) using by mutt_block_signals () */
 358   OPTSYSSIGNALSBLOCKED,         /* (pseudo) using by mutt_block_signals_system () */
 359   OPTNEEDRESORT,                /* (pseudo) used to force a re-sort */
 360   OPTRESORTINIT,                /* (pseudo) used to force the next resort to be from scratch */
 361   OPTVIEWATTACH,                /* (pseudo) signals that we are viewing attachments */
 362   OPTFORCEREDRAWINDEX,          /* (pseudo) used to force a redraw in the main index */
 363   OPTFORCEREDRAWPAGER,          /* (pseudo) used to force a redraw in the pager */
 364   OPTSORTSUBTHREADS,            /* (pseudo) used when $sort_aux changes */
 365   OPTNEEDRESCORE,               /* (pseudo) set when the `score' command is used */
 366   OPTATTACHMSG,                 /* (pseudo) used by attach-message */
 367   OPTHIDEREAD,                  /* (pseudo) whether or not hide read messages */
 368   OPTKEEPQUIET,                 /* (pseudo) shut up the message and refresh
 369                                  *          functions while we are executing an
 370                                  *          external program.
 371                                  */
 372   OPTMENUCALLER,                /* (pseudo) tell menu to give caller a take */
 373   OPTREDRAWTREE,                /* (pseudo) redraw the thread tree */
 374   OPTPGPCHECKTRUST,             /* (pseudo) used by pgp_select_key () */
 375   OPTUNBUFFEREDINPUT,           /* (pseudo) don't use key buffer */
 376
 377 #ifdef USE_NNTP
 378   OPTNEWS,                      /* (pseudo) used to change reader mode */
 379   OPTNEWSSEND,                  /* (pseudo) used to change behavior when posting */
 380   OPTNEWSCACHE,                 /* (pseudo) used to indicate if news cache exist */
 381 #endif
 382   OPTSHORTENHIERARCHY,          /* set when to shorten "hierarchies" in the sidebar */
 383   OPTSIDEBARNEWMAILONLY,
 384   OPTMAX
 385 };
 386
 387 #define mutt_bit_alloc(n) p_new(char, (n + 7) / 8)
 388 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
 389 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
 390 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
 391 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
 392
 393 #define set_option(x) mutt_bit_set(Options,x)
 394 #define unset_option(x) mutt_bit_unset(Options,x)
 395 #define toggle_option(x) mutt_bit_toggle(Options,x)
 396 #define option(x) mutt_bit_isset(Options,x)
 397
 398 void mutt_init (int, string_list_t *);
 399
 400 typedef struct thread {
 401   unsigned int fake_thread:1;
 402   unsigned int duplicate_thread:1;
 403   unsigned int sort_children:1;
 404   unsigned int check_subject:1;
 405   unsigned int visible:1;
 406   unsigned int deep:1;
 407   unsigned int subtree_visible:2;
 408   unsigned int next_subtree_visible:1;
 409   struct thread *parent;
 410   struct thread *child;
 411   struct thread *next;
 412   struct thread *prev;
 413   HEADER *message;
 414   HEADER *sort_key;
 415 } THREAD;
 416
 417 typedef struct compress_info compress_info;
 418 typedef struct pattern_t pattern_t;
 419
 420 typedef struct {
 421   char *path;
 422   FILE *fp;
 423   time_t mtime;
 424   time_t mtime_cur;             /* used with maildir folders */
 425   off_t size;
 426   off_t vsize;
 427   char *pattern;                /* limit pattern string */
 428   pattern_t *limit_pattern;     /* compiled limit pattern */
 429   HEADER **hdrs;
 430   HEADER *last_tag;             /* last tagged msg. used to link threads */
 431   THREAD *tree;                 /* top of thread tree */
 432   hash_t *id_hash;                /* hash table by msg id */
 433   hash_t *subj_hash;              /* hash table by subject */
 434   hash_t *thread_hash;            /* hash table for threading */
 435   int *v2r;                     /* mapping from virtual to real msgno */
 436   int hdrmax;                   /* number of pointers in hdrs */
 437   int msgcount;                 /* number of messages in the mailbox */
 438   int vcount;                   /* the number of virtual messages */
 439   int tagged;                   /* how many messages are tagged? */
 440   int new;                      /* how many new messages? */
 441   int unread;                   /* how many unread messages? */
 442   int deleted;                  /* how many deleted messages */
 443   int appended;                 /* how many saved messages? */
 444   int flagged;                  /* how many flagged messages */
 445   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 446   void *data;                   /* driver specific data */
 447
 448   short magic;                  /* mailbox type */
 449
 450   compress_info *cinfo;         /* compressed mbox module private data */
 451   char *realpath;               /* path to compressed mailbox */
 452
 453   unsigned int locked:1;        /* is the mailbox locked? */
 454   unsigned int changed:1;       /* mailbox has been modified */
 455   unsigned int readonly:1;      /* don't allow changes to the mailbox */
 456   unsigned int dontwrite:1;     /* dont write the mailbox on close */
 457   unsigned int append:1;        /* mailbox is opened in append mode */
 458   unsigned int quiet:1;         /* inhibit status messages? */
 459   unsigned int collapsed:1;     /* are all threads collapsed? */
 460   unsigned int closing:1;       /* mailbox is being closed */
 461   unsigned int counting:1;      /* do we just want to cound? */
 462 } CONTEXT;
 463
 464 /* for attachment counter */
 465 typedef struct {
 466   char *major;
 467   int major_int;
 468   const char *minor;
 469   regex_t minor_rx;
 470 } ATTACH_MATCH;
 471
 472 /* Flags for mutt_count_body_parts() */
 473 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
 474 #define M_PARTS_RECOUNT (1<<1) /* force recount */
 475
 476 #include "protos.h"
 477 #include "globals.h"
 478
 479 #endif /* !_MUTT_H */