2 * Copyright notice from original mutt:
3 * Copyright (C) 1996-8 Michael R. Elkins <me@mutt.org>
4 * Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
5 * Copyright (C) 1999-2002 Brendan Cully <brendan@kublai.com>
7 * This file is part of mutt-ng, see http://www.muttng.org/.
8 * It's licensed under the GNU General Public License,
9 * please see the file GPL in the top level source directory.
12 /* general IMAP utility functions */
17 #include "mx.h" /* for M_IMAP */
19 #include "imap_private.h"
24 #include "lib/debug.h"
29 #include <sys/types.h>
33 #include <netinet/in.h>
37 /* -- public functions -- */
39 /* imap_expand_path: IMAP implementation of mutt_expand_path. Rewrite
40 * an IMAP path in canonical and absolute form.
41 * Inputs: a buffer containing an IMAP path, and the number of bytes in
43 * Outputs: The buffer is rewritten in place with the canonical IMAP path.
44 * Returns 0 on success, or -1 if imap_parse_path chokes or url_ciss_tostring
45 * fails, which it might if there isn't enough room in the buffer. */
46 int imap_expand_path (char *path, size_t len)
52 if (imap_parse_path (path, &mx) < 0)
55 mutt_account_tourl (&mx.account, &url);
58 rc = url_ciss_tostring (&url, path, len, U_DECODE_PASSWD);
64 /* imap_parse_path: given an IMAP mailbox name, return host, port
65 * and a path IMAP servers will recognise.
66 * mx.mbox is malloc'd, caller must free it */
67 int imap_parse_path (const char *path, IMAP_MBOX * mx)
69 static unsigned short ImapPort = 0;
70 static unsigned short ImapsPort = 0;
71 struct servent *service;
76 service = getservbyname ("imap", "tcp");
78 ImapPort = ntohs (service->s_port);
81 debug_print (3, ("Using default IMAP port %d\n", ImapPort));
84 service = getservbyname ("imaps", "tcp");
86 ImapsPort = ntohs (service->s_port);
88 ImapsPort = IMAP_SSL_PORT;
89 debug_print (3, ("Using default IMAPS port %d\n", ImapsPort));
93 mx->account.flags = 0;
94 mx->account.port = ImapPort;
95 mx->account.type = M_ACCT_TYPE_IMAP;
98 url_parse_ciss (&url, c);
100 if (!(url.scheme == U_IMAP || url.scheme == U_IMAPS) ||
101 mutt_account_fromurl (&mx->account, &url) < 0) {
106 mx->mbox = str_dup (url.path);
108 if (url.scheme == U_IMAPS)
109 mx->account.flags |= M_ACCT_SSL;
113 if ((mx->account.flags & M_ACCT_SSL) && !(mx->account.flags & M_ACCT_PORT))
114 mx->account.port = ImapsPort;
119 /* imap_pretty_mailbox: called by mutt_pretty_mailbox to make IMAP paths
121 void imap_pretty_mailbox (char *path)
123 IMAP_MBOX home, target;
130 if (imap_parse_path (path, &target) < 0)
133 tlen = str_len (target.mbox);
134 /* check whether we can do '=' substitution */
135 if (mx_get_magic (Maildir) == M_IMAP && !imap_parse_path (Maildir, &home)) {
136 hlen = str_len (home.mbox);
137 if (tlen && mutt_account_match (&home.account, &target.account) &&
138 !str_ncmp (home.mbox, target.mbox, hlen)) {
142 for (delim = ImapDelimChars; *delim != '\0'; delim++)
143 if (target.mbox[hlen] == *delim)
146 mem_free (&home.mbox);
149 /* do the '=' substitution */
152 /* copy remaining path, skipping delimiter */
155 memcpy (path, target.mbox + hlen + 1, tlen - hlen - 1);
156 path[tlen - hlen - 1] = '\0';
159 mutt_account_tourl (&target.account, &url);
160 url.path = target.mbox;
161 /* FIXME: That hard-coded constant is bogus. But we need the actual
162 * size of the buffer from mutt_pretty_mailbox. And these pretty
163 * operations usually shrink the result. Still... */
164 url_ciss_tostring (&url, path, 1024, 0);
167 mem_free (&target.mbox);
170 /* -- library functions -- */
172 /* imap_continue: display a message and ask the user if she wants to
174 int imap_continue (const char *msg, const char *resp)
176 imap_error (msg, resp);
177 return mutt_yesorno (_("Continue?"), 0);
180 /* imap_error: show an error and abort */
181 void imap_error (const char *where, const char *msg)
183 mutt_error ("%s [%s]\n", where, msg);
187 /* imap_new_idata: Allocate and initialise a new IMAP_DATA structure.
188 * Returns NULL on failure (no mem) */
189 IMAP_DATA *imap_new_idata (void)
191 return mem_calloc (1, sizeof (IMAP_DATA));
194 /* imap_free_idata: Release and clear storage in an IMAP_DATA structure. */
195 void imap_free_idata (IMAP_DATA ** idata)
200 mem_free (&(*idata)->capstr);
201 mutt_free_list (&(*idata)->flags);
202 mem_free (&((*idata)->cmd.buf));
207 * Fix up the imap path. This is necessary because the rest of mutt
208 * assumes a hierarchy delimiter of '/', which is not necessarily true
209 * in IMAP. Additionally, the filesystem converts multiple hierarchy
210 * delimiters into a single one, ie "///" is equal to "/". IMAP servers
211 * are not required to do this.
212 * Moreover, IMAP servers may dislike the path ending with the delimiter.
214 char *imap_fix_path (IMAP_DATA * idata, char *mailbox, char *path,
219 if (!mailbox || !*mailbox) {
220 strfcpy (path, "INBOX", plen);
224 while (mailbox && *mailbox && (x < (plen - 1))) {
225 if ((*mailbox == '/') || (*mailbox == idata->delim)) {
226 while ((*mailbox == '/') || (*mailbox == idata->delim))
228 path[x] = idata->delim;
236 if (x && path[--x] != idata->delim)
242 /* imap_get_literal_count: write number of bytes in an IMAP literal into
243 * bytes, return 0 on success, -1 on failure. */
244 int imap_get_literal_count (const char *buf, long *bytes)
249 if (!(pc = strchr (buf, '{')))
253 while (isdigit ((unsigned char) *pc))
260 /* imap_get_qualifier: in a tagged response, skip tag and status for
261 * the qualifier message. Used by imap_copy_message for TRYCREATE */
262 char *imap_get_qualifier (char *buf)
267 s = imap_next_word (s);
268 /* skip OK/NO/BAD response */
269 s = imap_next_word (s);
274 /* imap_next_word: return index into string where next IMAP word begins */
275 char *imap_next_word (char *s)
287 quoted = quoted ? 0 : 1;
288 if (!quoted && ISSPACE (*s))
297 /* imap_parse_date: date is of the form: DD-MMM-YYYY HH:MM:SS +ZZzz */
298 time_t imap_parse_date (char *s)
303 t.tm_mday = (s[0] == ' ' ? s[1] - '0' : (s[0] - '0') * 10 + (s[1] - '0'));
308 t.tm_mon = mutt_check_month (s);
314 (s[0] - '0') * 1000 + (s[1] - '0') * 100 + (s[2] - '0') * 10 + (s[3] -
323 t.tm_hour = (s[0] - '0') * 10 + (s[1] - '0');
328 t.tm_min = (s[0] - '0') * 10 + (s[1] - '0');
333 t.tm_sec = (s[0] - '0') * 10 + (s[1] - '0');
340 tz = ((s[1] - '0') * 10 + (s[2] - '0')) * 3600 +
341 ((s[3] - '0') * 10 + (s[4] - '0')) * 60;
345 return (mutt_mktime (&t, 0) + tz);
348 /* imap_qualify_path: make an absolute IMAP folder target, given IMAP_MBOX
349 * and relative path. */
350 void imap_qualify_path (char *dest, size_t len, IMAP_MBOX * mx, char *path)
354 mutt_account_tourl (&mx->account, &url);
357 url_ciss_tostring (&url, dest, len, 0);
361 /* imap_quote_string: quote string according to IMAP rules:
362 * surround string with quotes, escape " and \ with \ */
363 void imap_quote_string (char *dest, size_t dlen, const char *src)
365 char quote[] = "\"\\", *pt;
372 /* save room for trailing quote-char */
375 for (; *s && dlen; s++) {
376 if (strchr (quote, *s)) {
392 /* imap_unquote_string: equally stupid unquoting routine */
393 void imap_unquote_string (char *s)
420 * Quoting and UTF-7 conversion
423 void imap_munge_mbox_name (char *dest, size_t dlen, const char *src)
428 imap_utf7_encode (&buf);
430 imap_quote_string (dest, dlen, buf);
435 void imap_unmunge_mbox_name (char *s)
439 imap_unquote_string (s);
443 imap_utf7_decode (&buf);
444 strncpy (s, buf, str_len (s));
450 /* imap_wordcasecmp: find word a in word list b */
451 int imap_wordcasecmp (const char *a, const char *b)
453 char tmp[SHORT_STRING];
454 char *s = (char *) b;
457 tmp[SHORT_STRING - 1] = 0;
458 for (i = 0; i < SHORT_STRING - 2; i++, s++) {
459 if (!*s || ISSPACE (*s)) {
467 return ascii_strcasecmp (a, tmp);
471 * Imap keepalive: poll the current folder to keep the
476 static RETSIGTYPE alrm_handler (int sig)
481 void imap_keepalive (void)
487 conn = mutt_socket_head ();
489 if (conn->account.type == M_ACCT_TYPE_IMAP) {
490 idata = (IMAP_DATA *) conn->data;
492 if (idata->state >= IMAP_AUTHENTICATED
493 && time (NULL) >= idata->lastread + ImapKeepalive) {
497 ctx = mem_calloc (1, sizeof (CONTEXT));
500 imap_check_mailbox (ctx, NULL, 1);
510 int imap_wait_keepalive (pid_t pid)
512 struct sigaction oldalrm;
513 struct sigaction act;
517 short imap_passive = option (OPTIMAPPASSIVE);
519 set_option (OPTIMAPPASSIVE);
520 set_option (OPTKEEPQUIET);
522 sigprocmask (SIG_SETMASK, NULL, &oldmask);
524 sigemptyset (&act.sa_mask);
525 act.sa_handler = alrm_handler;
527 act.sa_flags = SA_INTERRUPT;
532 sigaction (SIGALRM, &act, &oldalrm);
534 alarm (ImapKeepalive);
535 while (waitpid (pid, &rc, 0) < 0 && errno == EINTR) {
536 alarm (0); /* cancel a possibly pending alarm */
538 alarm (ImapKeepalive);
541 alarm (0); /* cancel a possibly pending alarm */
543 sigaction (SIGALRM, &oldalrm, NULL);
544 sigprocmask (SIG_SETMASK, &oldmask, NULL);
546 unset_option (OPTKEEPQUIET);
548 unset_option (OPTIMAPPASSIVE);
553 /* Allow/disallow re-opening a folder upon expunge. */
555 void imap_allow_reopen (CONTEXT * ctx)
557 if (ctx && ctx->magic == M_IMAP && CTX_DATA->ctx == ctx)
558 CTX_DATA->reopen |= IMAP_REOPEN_ALLOW;
561 void imap_disallow_reopen (CONTEXT * ctx)
563 if (ctx && ctx->magic == M_IMAP && CTX_DATA->ctx == ctx)
564 CTX_DATA->reopen &= ~IMAP_REOPEN_ALLOW;