imap/imap_private.h

   1 /*
   2  * Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
   3  * Copyright (C) 1999-2005 Brendan Cully <brendan@kublai.com>
   4  *
   5  *     This program is free software; you can redistribute it and/or modify
   6  *     it under the terms of the GNU General Public License as published by
   7  *     the Free Software Foundation; either version 2 of the License, or
   8  *     (at your option) any later version.
   9  *
  10  *     This program is distributed in the hope that it will be useful,
  11  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *     GNU General Public License for more details.
  14  *
  15  *     You should have received a copy of the GNU General Public License
  16  *     along with this program; if not, write to the Free Software
  17  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  */
  19
  20 #ifndef _IMAP_PRIVATE_H
  21 #define _IMAP_PRIVATE_H 1
  22
  23 #include "imap.h"
  24 #include "mutt_curses.h"
  25 #include "mutt_socket.h"
  26 #include "bcache.h"
  27 #ifdef USE_HCACHE
  28 #include "hcache.h"
  29 #endif
  30
  31 /* -- symbols -- */
  32 #define IMAP_PORT 143
  33 #define IMAP_SSL_PORT 993
  34
  35 /* logging levels */
  36 #define IMAP_LOG_CMD  2
  37 #define IMAP_LOG_LTRL 4
  38 #define IMAP_LOG_PASS 5
  39
  40 /* IMAP command responses. Used in IMAP_COMMAND.state too */
  41 /* <tag> OK ... */
  42 #define IMAP_CMD_OK       (0)
  43 /* <tag> BAD ... */
  44 #define IMAP_CMD_BAD      (-1)
  45 /* <tag> NO ... */
  46 #define IMAP_CMD_NO       (-2)
  47 /* * ... */
  48 #define IMAP_CMD_CONTINUE (1)
  49 /* + */
  50 #define IMAP_CMD_RESPOND  (2)
  51 /* IMAP_COMMAND.state additions */
  52 #define IMAP_CMD_NEW    (3)
  53
  54 /* number of entries in the hash table */
  55 #define IMAP_CACHE_LEN 10
  56
  57 /* number of commands that can be batched into a single request
  58  * ( - 1, for the easy way to detect ring buffer wrap) */
  59 #define IMAP_PIPELINE_DEPTH 15
  60
  61 #define SEQLEN 5
  62
  63 #define IMAP_REOPEN_ALLOW     (1<<0)
  64 #define IMAP_EXPUNGE_EXPECTED (1<<1)
  65 #define IMAP_EXPUNGE_PENDING  (1<<2)
  66 #define IMAP_NEWMAIL_PENDING  (1<<3)
  67 #define IMAP_FLAGS_PENDING    (1<<4)
  68
  69 /* imap_exec flags (see imap_exec) */
  70 #define IMAP_CMD_FAIL_OK (1<<0)
  71 #define IMAP_CMD_PASS    (1<<1)
  72
  73 enum
  74 {
  75   IMAP_FATAL = 1,
  76   IMAP_BYE,
  77   IMAP_REOPENED
  78 };
  79
  80 enum
  81 {
  82   /* States */
  83   IMAP_DISCONNECTED = 0,
  84   IMAP_CONNECTED,
  85   IMAP_AUTHENTICATED,
  86   IMAP_SELECTED,
  87
  88   /* and pseudo-states */
  89   IMAP_IDLE
  90 };
  91
  92 enum
  93 {
  94   /* Namespace types */
  95   IMAP_NS_PERSONAL = 0,
  96   IMAP_NS_OTHER,
  97   IMAP_NS_SHARED
  98 };
  99
 100 /* Capabilities we are interested in */
 101 enum
 102 {
 103   IMAP4 = 0,
 104   IMAP4REV1,
 105   STATUS,
 106   ACL,                          /* RFC 2086: IMAP4 ACL extension */
 107   NAMESPACE,                    /* RFC 2342: IMAP4 Namespace */
 108   ACRAM_MD5,                    /* RFC 2195: CRAM-MD5 authentication */
 109   AGSSAPI,                      /* RFC 1731: GSSAPI authentication */
 110   AUTH_ANON,                    /* AUTH=ANONYMOUS */
 111   STARTTLS,                     /* RFC 2595: STARTTLS */
 112   LOGINDISABLED,                /*           LOGINDISABLED */
 113   IDLE,                         /* RFC 2177: IDLE */
 114   SASL_IR,                      /* SASL initial response draft */
 115
 116   CAPMAX
 117 };
 118
 119 /* imap_conn_find flags */
 120 #define M_IMAP_CONN_NONEW    (1<<0)
 121 #define M_IMAP_CONN_NOSELECT (1<<1)
 122
 123 /* -- data structures -- */
 124 typedef struct
 125 {
 126   unsigned int uid;
 127   char* path;
 128 } IMAP_CACHE;
 129
 130 typedef struct
 131 {
 132   char* name;
 133
 134   unsigned int messages;
 135   unsigned int recent;
 136   unsigned int uidnext;
 137   unsigned int uidvalidity;
 138   unsigned int unseen;
 139 } IMAP_STATUS;
 140
 141 typedef struct
 142 {
 143   char* name;
 144
 145   char delim;
 146   /* if we end up storing a lot of these we could turn this into a bitfield */
 147   unsigned char noselect;
 148   unsigned char noinferiors;
 149 } IMAP_LIST;
 150
 151 /* IMAP command structure */
 152 typedef struct
 153 {
 154   char seq[SEQLEN+1];
 155   int state;
 156 } IMAP_COMMAND;
 157
 158 typedef enum
 159 {
 160   IMAP_CT_NONE = 0,
 161   IMAP_CT_LIST,
 162   IMAP_CT_STATUS
 163 } IMAP_COMMAND_TYPE;
 164
 165 typedef struct
 166 {
 167   /* This data is specific to a CONNECTION to an IMAP server */
 168   CONNECTION *conn;
 169   unsigned char state;
 170   unsigned char status;
 171   /* let me explain capstr: SASL needs the capability string (not bits).
 172    * we have 3 options:
 173    *   1. rerun CAPABILITY inside SASL function.
 174    *   2. build appropriate CAPABILITY string by reverse-engineering from bits.
 175    *   3. keep a copy until after authentication.
 176    * I've chosen (3) for now. (2) might not be too bad, but it involves
 177    * tracking all possible capabilities. bah. (1) I don't like because
 178    * it's just no fun to get the same information twice */
 179   char* capstr;
 180   unsigned char capabilities[(CAPMAX + 7)/8];
 181   unsigned int seqno;
 182   time_t lastread; /* last time we read a command for the server */
 183   char* buf;
 184   unsigned int blen;
 185
 186   /* if set, the response parser will store results for complicated commands
 187    * here. */
 188   IMAP_COMMAND_TYPE cmdtype;
 189   void* cmddata;
 190
 191   /* command queue */
 192   IMAP_COMMAND cmds[IMAP_PIPELINE_DEPTH];
 193   int nextcmd;
 194   int lastcmd;
 195   BUFFER* cmdbuf;
 196
 197   /* cache IMAP_STATUS of visited mailboxes */
 198   LIST* mboxcache;
 199
 200   /* The following data is all specific to the currently SELECTED mbox */
 201   char delim;
 202   CONTEXT *ctx;
 203   char *mailbox;
 204   unsigned short check_status;
 205   unsigned char reopen;
 206   unsigned int newMailCount;
 207   IMAP_CACHE cache[IMAP_CACHE_LEN];
 208   unsigned int uid_validity;
 209   unsigned int uidnext;
 210   body_cache_t *bcache;
 211
 212   /* all folder flags - system flags AND keywords */
 213   LIST *flags;
 214 #ifdef USE_HCACHE
 215   header_cache_t *hcache;
 216 #endif
 217 } IMAP_DATA;
 218 /* I wish that were called IMAP_CONTEXT :( */
 219
 220 /* -- macros -- */
 221 #define CTX_DATA ((IMAP_DATA *) ctx->data)
 222
 223 /* -- private IMAP functions -- */
 224 /* imap.c */
 225 int imap_create_mailbox (IMAP_DATA* idata, char* mailbox);
 226 int imap_rename_mailbox (IMAP_DATA* idata, IMAP_MBOX* mx, const char* newname);
 227 IMAP_STATUS* imap_mboxcache_get (IMAP_DATA* idata, const char* mbox,
 228                                  int create);
 229 void imap_mboxcache_free (IMAP_DATA* idata);
 230 int imap_make_msg_set (IMAP_DATA* idata, BUFFER* buf, int flag, int changed,
 231                        int invert);
 232 int imap_open_connection (IMAP_DATA* idata);
 233 void imap_close_connection (IMAP_DATA* idata);
 234 IMAP_DATA* imap_conn_find (const ACCOUNT* account, int flags);
 235 int imap_read_literal (FILE* fp, IMAP_DATA* idata, long bytes, progress_t*);
 236 void imap_expunge_mailbox (IMAP_DATA* idata);
 237 void imap_logout (IMAP_DATA* idata);
 238 int imap_sync_message (IMAP_DATA *idata, HEADER *hdr, BUFFER *cmd,
 239   int *err_continue);
 240 int imap_has_flag (LIST* flag_list, const char* flag);
 241
 242 /* auth.c */
 243 int imap_authenticate (IMAP_DATA* idata);
 244
 245 /* command.c */
 246 int imap_cmd_queue (IMAP_DATA* idata, const char* cmdstr);
 247 int imap_cmd_start (IMAP_DATA* idata, const char* cmd);
 248 int imap_cmd_step (IMAP_DATA* idata);
 249 void imap_cmd_finish (IMAP_DATA* idata);
 250 int imap_code (const char* s);
 251 int imap_exec (IMAP_DATA* idata, const char* cmd, int flags);
 252
 253 /* message.c */
 254 void imap_add_keywords (char* s, HEADER* keywords, LIST* mailbox_flags, size_t slen);
 255 void imap_free_header_data (void** data);
 256 int imap_read_headers (IMAP_DATA* idata, int msgbegin, int msgend);
 257 char* imap_set_flags (IMAP_DATA* idata, HEADER* h, char* s);
 258 int imap_cache_del (IMAP_DATA* idata, HEADER* h);
 259 int imap_cache_clean (IMAP_DATA* idata);
 260
 261 /* util.c */
 262 #ifdef USE_HCACHE
 263 header_cache_t* imap_hcache_open (IMAP_DATA* idata, const char* path);
 264 void imap_hcache_close (IMAP_DATA* idata);
 265 HEADER* imap_hcache_get (IMAP_DATA* idata, unsigned int uid);
 266 int imap_hcache_put (IMAP_DATA* idata, HEADER* h);
 267 int imap_hcache_del (IMAP_DATA* idata, unsigned int uid);
 268 #endif
 269
 270 int imap_continue (const char* msg, const char* resp);
 271 void imap_error (const char* where, const char* msg);
 272 IMAP_DATA* imap_new_idata (void);
 273 void imap_free_idata (IMAP_DATA** idata);
 274 char* imap_fix_path (IMAP_DATA* idata, char* mailbox, char* path,
 275   size_t plen);
 276 void imap_cachepath(IMAP_DATA* idata, const char* mailbox, char* dest,
 277                     size_t dlen);
 278 int imap_get_literal_count (const char* buf, long* bytes);
 279 char* imap_get_qualifier (char* buf);
 280 int imap_mxcmp (const char* mx1, const char* mx2);
 281 char* imap_next_word (char* s);
 282 time_t imap_parse_date (char* s);
 283 void imap_qualify_path (char *dest, size_t len, IMAP_MBOX *mx, char* path);
 284 void imap_quote_string (char* dest, size_t slen, const char* src);
 285 void imap_unquote_string (char* s);
 286 void imap_munge_mbox_name (char *dest, size_t dlen, const char *src);
 287 void imap_unmunge_mbox_name (char *s);
 288 int imap_wordcasecmp(const char *a, const char *b);
 289
 290 /* utf7.c */
 291 void imap_utf7_encode (char **s);
 292 void imap_utf7_decode (char **s);
 293
 294 #if USE_HCACHE
 295 /* typedef size_t (*hcache_keylen_t)(const char* fn); */
 296 #define imap_hcache_keylen mutt_strlen
 297 #endif /* USE_HCACHE */
 298
 299 #endif