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 */
16 #include <lib-lib/mem.h>
19 #include "mx.h" /* for M_IMAP */
22 #include "imap_private.h"
27 #include "lib/debug.h"
32 #include <sys/types.h>
36 #include <netinet/in.h>
40 /* -- public functions -- */
42 /* imap_expand_path: IMAP implementation of mutt_expand_path. Rewrite
43 * an IMAP path in canonical and absolute form.
44 * Inputs: a buffer containing an IMAP path, and the number of bytes in
46 * Outputs: The buffer is rewritten in place with the canonical IMAP path.
47 * Returns 0 on success, or -1 if imap_parse_path chokes or url_ciss_tostring
48 * fails, which it might if there isn't enough room in the buffer. */
49 int imap_expand_path (char *path, size_t len)
55 if (imap_parse_path (path, &mx) < 0)
58 mutt_account_tourl (&mx.account, &url);
61 rc = url_ciss_tostring (&url, path, len, U_DECODE_PASSWD);
67 /* imap_parse_path: given an IMAP mailbox name, return host, port
68 * and a path IMAP servers will recognise.
69 * mx.mbox is malloc'd, caller must free it */
70 int imap_parse_path (const char *path, IMAP_MBOX * mx)
72 static unsigned short ImapPort = 0;
73 static unsigned short ImapsPort = 0;
74 struct servent *service;
79 service = getservbyname ("imap", "tcp");
81 ImapPort = ntohs (service->s_port);
84 debug_print (3, ("Using default IMAP port %d\n", ImapPort));
87 service = getservbyname ("imaps", "tcp");
89 ImapsPort = ntohs (service->s_port);
91 ImapsPort = IMAP_SSL_PORT;
92 debug_print (3, ("Using default IMAPS port %d\n", ImapsPort));
96 mx->account.flags = 0;
97 mx->account.port = ImapPort;
98 mx->account.type = M_ACCT_TYPE_IMAP;
101 url_parse_ciss (&url, c);
103 if (!(url.scheme == U_IMAP || url.scheme == U_IMAPS) ||
104 mutt_account_fromurl (&mx->account, &url) < 0 || !*mx->account.host) {
109 mx->mbox = str_dup (url.path);
111 if (url.scheme == U_IMAPS)
112 mx->account.flags |= M_ACCT_SSL;
116 if ((mx->account.flags & M_ACCT_SSL) && !(mx->account.flags & M_ACCT_PORT))
117 mx->account.port = ImapsPort;
122 /* imap_pretty_mailbox: called by mutt_pretty_mailbox to make IMAP paths
124 void imap_pretty_mailbox (char *path)
126 IMAP_MBOX home, target;
133 if (imap_parse_path (path, &target) < 0)
136 tlen = str_len (target.mbox);
137 /* check whether we can do '=' substitution */
138 if (mx_get_magic (Maildir) == M_IMAP && !imap_parse_path (Maildir, &home)) {
139 hlen = str_len (home.mbox);
140 if (tlen && mutt_account_match (&home.account, &target.account) &&
141 !str_ncmp (home.mbox, target.mbox, hlen)) {
145 for (delim = ImapDelimChars; *delim != '\0'; delim++)
146 if (target.mbox[hlen] == *delim)
149 p_delete(&home.mbox);
152 /* do the '=' substitution */
155 /* copy remaining path, skipping delimiter */
158 memcpy (path, target.mbox + hlen + 1, tlen - hlen - 1);
159 path[tlen - hlen - 1] = '\0';
162 mutt_account_tourl (&target.account, &url);
163 url.path = target.mbox;
164 /* FIXME: That hard-coded constant is bogus. But we need the actual
165 * size of the buffer from mutt_pretty_mailbox. And these pretty
166 * operations usually shrink the result. Still... */
167 url_ciss_tostring (&url, path, 1024, 0);
170 p_delete(&target.mbox);
173 /* -- library functions -- */
175 /* imap_continue: display a message and ask the user if she wants to
177 int imap_continue (const char *msg, const char *resp)
179 imap_error (msg, resp);
180 return mutt_yesorno (_("Continue?"), 0);
183 /* imap_error: show an error and abort */
184 void imap_error (const char *where, const char *msg)
186 mutt_error ("%s [%s]\n", where, msg);
190 /* imap_new_idata: Allocate and initialise a new IMAP_DATA structure.
191 * Returns NULL on failure (no mem) */
192 IMAP_DATA *imap_new_idata (void)
194 return p_new(IMAP_DATA, 1);
197 /* imap_free_idata: Release and clear storage in an IMAP_DATA structure. */
198 void imap_free_idata (IMAP_DATA ** idata)
203 p_delete(&(*idata)->capstr);
204 mutt_free_list (&(*idata)->flags);
205 p_delete(&((*idata)->cmd.buf));
210 * Fix up the imap path. This is necessary because the rest of mutt
211 * assumes a hierarchy delimiter of '/', which is not necessarily true
212 * in IMAP. Additionally, the filesystem converts multiple hierarchy
213 * delimiters into a single one, ie "///" is equal to "/". IMAP servers
214 * are not required to do this.
215 * Moreover, IMAP servers may dislike the path ending with the delimiter.
217 char *imap_fix_path (IMAP_DATA * idata, char *mailbox, char *path,
222 if (!mailbox || !*mailbox) {
223 strfcpy (path, "INBOX", plen);
227 while (mailbox && *mailbox && (x < (plen - 1))) {
228 if ((*mailbox == '/') || (*mailbox == idata->delim)) {
229 while ((*mailbox == '/') || (*mailbox == idata->delim))
231 path[x] = idata->delim;
239 if (x && path[--x] != idata->delim)
245 /* imap_get_literal_count: write number of bytes in an IMAP literal into
246 * bytes, return 0 on success, -1 on failure. */
247 int imap_get_literal_count (const char *buf, long *bytes)
252 if (!(pc = strchr (buf, '{')))
256 while (isdigit ((unsigned char) *pc))
263 /* imap_get_qualifier: in a tagged response, skip tag and status for
264 * the qualifier message. Used by imap_copy_message for TRYCREATE */
265 char *imap_get_qualifier (char *buf)
270 s = imap_next_word (s);
271 /* skip OK/NO/BAD response */
272 s = imap_next_word (s);
277 /* imap_next_word: return index into string where next IMAP word begins */
278 char *imap_next_word (char *s)
290 quoted = quoted ? 0 : 1;
291 if (!quoted && ISSPACE (*s))
300 /* imap_parse_date: date is of the form: DD-MMM-YYYY HH:MM:SS +ZZzz */
301 time_t imap_parse_date (char *s)
306 t.tm_mday = (s[0] == ' ' ? s[1] - '0' : (s[0] - '0') * 10 + (s[1] - '0'));
311 t.tm_mon = mutt_check_month (s);
317 (s[0] - '0') * 1000 + (s[1] - '0') * 100 + (s[2] - '0') * 10 + (s[3] -
326 t.tm_hour = (s[0] - '0') * 10 + (s[1] - '0');
331 t.tm_min = (s[0] - '0') * 10 + (s[1] - '0');
336 t.tm_sec = (s[0] - '0') * 10 + (s[1] - '0');
343 tz = ((s[1] - '0') * 10 + (s[2] - '0')) * 3600 +
344 ((s[3] - '0') * 10 + (s[4] - '0')) * 60;
348 return (mutt_mktime (&t, 0) + tz);
351 /* imap_qualify_path: make an absolute IMAP folder target, given IMAP_MBOX
352 * and relative path. */
353 void imap_qualify_path (char *dest, size_t len, IMAP_MBOX * mx, char *path)
357 mutt_account_tourl (&mx->account, &url);
360 url_ciss_tostring (&url, dest, len, 0);
364 /* imap_quote_string: quote string according to IMAP rules:
365 * surround string with quotes, escape " and \ with \ */
366 void imap_quote_string (char *dest, size_t dlen, const char *src)
368 char quote[] = "\"\\", *pt;
375 /* save room for trailing quote-char */
378 for (; *s && dlen; s++) {
379 if (strchr (quote, *s)) {
395 /* imap_unquote_string: equally stupid unquoting routine */
396 void imap_unquote_string (char *s)
423 * Quoting and UTF-7 conversion
426 void imap_munge_mbox_name (char *dest, size_t dlen, const char *src)
431 imap_utf7_encode (&buf);
433 imap_quote_string (dest, dlen, buf);
438 void imap_unmunge_mbox_name (char *s)
442 imap_unquote_string (s);
446 imap_utf7_decode (&buf);
447 strncpy (s, buf, str_len (s));
453 /* imap_wordcasecmp: find word a in word list b */
454 int imap_wordcasecmp (const char *a, const char *b)
456 char tmp[SHORT_STRING];
457 char *s = (char *) b;
460 tmp[SHORT_STRING - 1] = 0;
461 for (i = 0; i < SHORT_STRING - 2; i++, s++) {
462 if (!*s || ISSPACE (*s)) {
470 return ascii_strcasecmp (a, tmp);
474 * Imap keepalive: poll the current folder to keep the
479 static RETSIGTYPE alrm_handler (int sig)
484 void imap_keepalive (void)
490 conn = mutt_socket_head ();
492 if (conn->account.type == M_ACCT_TYPE_IMAP) {
493 idata = (IMAP_DATA *) conn->data;
495 if (idata->state >= IMAP_AUTHENTICATED
496 && time (NULL) >= idata->lastread + ImapKeepalive) {
500 ctx = p_new(CONTEXT, 1);
503 imap_check_mailbox (ctx, NULL, 1);
513 int imap_wait_keepalive (pid_t pid)
515 struct sigaction oldalrm;
516 struct sigaction act;
520 short imap_passive = option (OPTIMAPPASSIVE);
521 int imap_askreconnect = quadoption (OPT_IMAPRECONNECT);
523 set_option (OPTIMAPPASSIVE);
524 set_option (OPTKEEPQUIET);
525 set_quadoption (OPT_IMAPRECONNECT, M_NO);
527 sigprocmask (SIG_SETMASK, NULL, &oldmask);
529 sigemptyset (&act.sa_mask);
530 act.sa_handler = alrm_handler;
532 act.sa_flags = SA_INTERRUPT;
537 sigaction (SIGALRM, &act, &oldalrm);
539 alarm (ImapKeepalive);
540 while (waitpid (pid, &rc, 0) < 0 && errno == EINTR) {
541 alarm (0); /* cancel a possibly pending alarm */
543 alarm (ImapKeepalive);
546 alarm (0); /* cancel a possibly pending alarm */
548 sigaction (SIGALRM, &oldalrm, NULL);
549 sigprocmask (SIG_SETMASK, &oldmask, NULL);
551 unset_option (OPTKEEPQUIET);
553 unset_option (OPTIMAPPASSIVE);
554 set_quadoption (OPT_IMAPRECONNECT, imap_askreconnect);
559 /* Allow/disallow re-opening a folder upon expunge. */
561 void imap_allow_reopen (CONTEXT * ctx)
563 if (ctx && ctx->magic == M_IMAP && CTX_DATA->ctx == ctx)
564 CTX_DATA->reopen |= IMAP_REOPEN_ALLOW;
567 void imap_disallow_reopen (CONTEXT * ctx)
569 if (ctx && ctx->magic == M_IMAP && CTX_DATA->ctx == ctx)
570 CTX_DATA->reopen &= ~IMAP_REOPEN_ALLOW;