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 */
14 #include <lib-lib/lib-lib.h>
17 #include <lib-mx/mx.h>
20 #include "imap_private.h"
22 /* -- public functions -- */
24 /* imap_parse_path: given an IMAP mailbox name, return host, port
25 * and a path IMAP servers will recognise.
26 * mx.mbox is malloc'd, caller must free it */
27 int imap_parse_path (const char *path, IMAP_MBOX * mx)
29 static unsigned short ImapPort = 0;
30 static unsigned short ImapsPort = 0;
31 struct servent *service;
36 service = getservbyname ("imap", "tcp");
38 ImapPort = ntohs (service->s_port);
43 service = getservbyname ("imaps", "tcp");
45 ImapsPort = ntohs (service->s_port);
47 ImapsPort = IMAP_SSL_PORT;
51 mx->account.flags = 0;
52 mx->account.port = ImapPort;
53 mx->account.type = M_ACCT_TYPE_IMAP;
56 url_parse_ciss (&url, c);
58 if (!(url.scheme == U_IMAP || url.scheme == U_IMAPS) ||
59 mutt_account_fromurl (&mx->account, &url) < 0 || !*mx->account.host) {
64 mx->mbox = m_strdup(url.path);
66 if (url.scheme == U_IMAPS)
67 mx->account.flags |= M_ACCT_SSL;
71 if ((mx->account.flags & M_ACCT_SSL) && !(mx->account.flags & M_ACCT_PORT))
72 mx->account.port = ImapsPort;
77 /* imap_pretty_mailbox: called by mutt_pretty_mailbox to make IMAP paths
79 void imap_pretty_mailbox (char *path)
81 IMAP_MBOX home, target;
88 if (imap_parse_path (path, &target) < 0)
91 tlen = m_strlen(target.mbox);
92 /* check whether we can do '=' substitution */
93 if (mx_get_magic (Maildir) == M_IMAP && !imap_parse_path (Maildir, &home)) {
94 hlen = m_strlen(home.mbox);
95 if (tlen && mutt_account_match (&home.account, &target.account) &&
96 !m_strncmp(home.mbox, target.mbox, hlen)) {
100 for (delim = ImapDelimChars; *delim != '\0'; delim++)
101 if (target.mbox[hlen] == *delim)
104 p_delete(&home.mbox);
107 /* do the '=' substitution */
110 /* copy remaining path, skipping delimiter */
113 memcpy (path, target.mbox + hlen + 1, tlen - hlen - 1);
114 path[tlen - hlen - 1] = '\0';
117 mutt_account_tourl (&target.account, &url);
118 url.path = target.mbox;
119 /* FIXME: That hard-coded constant is bogus. But we need the actual
120 * size of the buffer from mutt_pretty_mailbox. And these pretty
121 * operations usually shrink the result. Still... */
122 url_ciss_tostring (&url, path, 1024, 0);
125 p_delete(&target.mbox);
128 /* -- library functions -- */
130 /* imap_continue: display a message and ask the user if she wants to
132 int imap_continue (const char *msg, const char *resp)
134 imap_error (msg, resp);
135 return mutt_yesorno (_("Continue?"), 0);
138 /* imap_error: show an error and abort */
139 void imap_error (const char *where, const char *msg)
141 mutt_error ("%s [%s]\n", where, msg);
145 /* imap_new_idata: Allocate and initialise a new IMAP_DATA structure.
146 * Returns NULL on failure (no mem) */
147 IMAP_DATA *imap_new_idata (void)
149 return p_new(IMAP_DATA, 1);
152 /* imap_free_idata: Release and clear storage in an IMAP_DATA structure. */
153 void imap_free_idata (IMAP_DATA ** idata)
158 p_delete(&(*idata)->capstr);
159 string_list_wipe(&(*idata)->flags);
160 p_delete(&((*idata)->cmd.buf));
165 * Fix up the imap path. This is necessary because the rest of mutt
166 * assumes a hierarchy delimiter of '/', which is not necessarily true
167 * in IMAP. Additionally, the filesystem converts multiple hierarchy
168 * delimiters into a single one, ie "///" is equal to "/". IMAP servers
169 * are not required to do this.
170 * Moreover, IMAP servers may dislike the path ending with the delimiter.
172 char *imap_fix_path (IMAP_DATA * idata, char *mailbox, char *path,
177 if (!mailbox || !*mailbox) {
178 m_strcpy(path, plen, "INBOX");
182 while (mailbox && *mailbox && (x < (plen - 1))) {
183 if ((*mailbox == '/') || (*mailbox == idata->delim)) {
184 while ((*mailbox == '/') || (*mailbox == idata->delim))
186 path[x] = idata->delim;
194 if (x && path[--x] != idata->delim)
200 /* imap_get_literal_count: write number of bytes in an IMAP literal into
201 * bytes, return 0 on success, -1 on failure. */
202 int imap_get_literal_count (const char *buf, long *bytes)
207 if (!(pc = strchr (buf, '{')))
211 while (isdigit ((unsigned char) *pc))
218 /* imap_get_qualifier: in a tagged response, skip tag and status for
219 * the qualifier message. Used by imap_copy_message for TRYCREATE */
220 char *imap_get_qualifier (char *buf)
225 s = imap_next_word (s);
226 /* skip OK/NO/BAD response */
227 s = imap_next_word (s);
232 /* imap_next_word: return index into string where next IMAP word begins */
233 char *imap_next_word (char *s)
245 quoted = quoted ? 0 : 1;
246 if (!quoted && ISSPACE (*s))
251 return vskipspaces(s);
254 /* imap_parse_date: date is of the form: DD-MMM-YYYY HH:MM:SS +ZZzz */
255 time_t imap_parse_date (char *s)
260 t.tm_mday = strtol(s, &s, 10);
263 t.tm_mon = mutt_check_month(s);
267 t.tm_year = strtol(s, &s, 10) - 1900;
272 t.tm_hour = strtol(s, &s, 10);
275 t.tm_min = strtol(s, &s, 10);
278 t.tm_sec = strtol(s, &s, 10);
283 tz = strtol(s + 1, NULL, 10);
284 tz = (tz / 100) * 3600 + (tz % 100) * 60;
288 return (mutt_mktime (&t, 0) + tz);
291 /* imap_qualify_path: make an absolute IMAP folder target, given IMAP_MBOX
292 * and relative path. */
293 void imap_qualify_path (char *dest, size_t len, IMAP_MBOX * mx, char *path)
297 mutt_account_tourl (&mx->account, &url);
300 url_ciss_tostring (&url, dest, len, 0);
304 /* imap_quote_string: quote string according to IMAP rules:
305 * surround string with quotes, escape " and \ with \ */
306 void imap_quote_string (char *dest, size_t dlen, const char *src)
308 char quote[] = "\"\\", *pt;
315 /* save room for trailing quote-char */
318 for (; *s && dlen; s++) {
319 if (strchr (quote, *s)) {
335 /* imap_unquote_string: equally stupid unquoting routine */
336 void imap_unquote_string (char *s)
363 * Quoting and UTF-7 conversion
366 void imap_munge_mbox_name (char *dest, size_t dlen, const char *src)
371 imap_utf7_encode (&buf);
373 imap_quote_string (dest, dlen, buf);
378 void imap_unmunge_mbox_name (char *s)
382 imap_unquote_string (s);
386 imap_utf7_decode (&buf);
387 m_strcpy(s, m_strlen(s) + 1, buf);
393 /* imap_wordcasecmp: find word a in word list b */
394 int imap_wordcasecmp (const char *a, const char *b)
397 char *s = (char *) b;
401 for (i = 0; i < STRING - 2; i++, s++) {
402 if (!*s || ISSPACE (*s)) {
410 return ascii_strcasecmp (a, tmp);
414 * Imap keepalive: poll the current folder to keep the
419 static RETSIGTYPE alrm_handler (int sig __attribute__((unused)))
424 void imap_keepalive (void)
430 conn = mutt_socket_head ();
432 if (conn->account.type == M_ACCT_TYPE_IMAP) {
433 idata = (IMAP_DATA *) conn->data;
435 if (idata->state >= IMAP_AUTHENTICATED
436 && time (NULL) >= idata->lastread + ImapKeepalive) {
440 ctx = p_new(CONTEXT, 1);
443 imap_check_mailbox (ctx, NULL, 1);
453 int imap_wait_keepalive (pid_t pid)
455 struct sigaction oldalrm;
456 struct sigaction act;
460 short imap_passive = option (OPTIMAPPASSIVE);
461 int imap_askreconnect = quadoption (OPT_IMAPRECONNECT);
463 set_option (OPTIMAPPASSIVE);
464 set_option (OPTKEEPQUIET);
465 set_quadoption (OPT_IMAPRECONNECT, M_NO);
467 sigprocmask (SIG_SETMASK, NULL, &oldmask);
469 sigemptyset (&act.sa_mask);
470 act.sa_handler = alrm_handler;
472 act.sa_flags = SA_INTERRUPT;
477 sigaction (SIGALRM, &act, &oldalrm);
479 alarm (ImapKeepalive);
480 while (waitpid (pid, &rc, 0) < 0 && errno == EINTR) {
481 alarm (0); /* cancel a possibly pending alarm */
483 alarm (ImapKeepalive);
486 alarm (0); /* cancel a possibly pending alarm */
488 sigaction (SIGALRM, &oldalrm, NULL);
489 sigprocmask (SIG_SETMASK, &oldmask, NULL);
491 unset_option (OPTKEEPQUIET);
493 unset_option (OPTIMAPPASSIVE);
494 set_quadoption (OPT_IMAPRECONNECT, imap_askreconnect);
499 /* Allow/disallow re-opening a folder upon expunge. */
501 void imap_allow_reopen (CONTEXT * ctx)
503 if (ctx && ctx->magic == M_IMAP && CTX_DATA->ctx == ctx)
504 CTX_DATA->reopen |= IMAP_REOPEN_ALLOW;
507 void imap_disallow_reopen (CONTEXT * ctx)
509 if (ctx && ctx->magic == M_IMAP && CTX_DATA->ctx == ctx)
510 CTX_DATA->reopen &= ~IMAP_REOPEN_ALLOW;