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.has_ssl = 1;
71 if (mx->account.has_ssl && !mx->account.has_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 IMAP_DATA *res = p_new(IMAP_DATA, 1);
150 buffer_init(&res->cmd.buf);
155 /* imap_free_idata: Release and clear storage in an IMAP_DATA structure. */
156 void imap_free_idata (IMAP_DATA ** idata)
159 p_delete(&(*idata)->capstr);
160 string_list_wipe(&(*idata)->flags);
161 buffer_wipe(&((*idata)->cmd.buf));
167 * Fix up the imap path. This is necessary because the rest of mutt
168 * assumes a hierarchy delimiter of '/', which is not necessarily true
169 * in IMAP. Additionally, the filesystem converts multiple hierarchy
170 * delimiters into a single one, ie "///" is equal to "/". IMAP servers
171 * are not required to do this.
172 * Moreover, IMAP servers may dislike the path ending with the delimiter.
174 char *imap_fix_path (IMAP_DATA * idata, char *mailbox, char *path,
179 if (!mailbox || !*mailbox) {
180 m_strcpy(path, plen, "INBOX");
184 while (mailbox && *mailbox && (x < (plen - 1))) {
185 if ((*mailbox == '/') || (*mailbox == idata->delim)) {
186 while ((*mailbox == '/') || (*mailbox == idata->delim))
188 path[x] = idata->delim;
196 if (x && path[--x] != idata->delim)
202 /* imap_get_literal_count: write number of bytes in an IMAP literal into
203 * bytes, return 0 on success, -1 on failure. */
204 int imap_get_literal_count (const char *buf, long *bytes)
209 if (!(pc = strchr (buf, '{')))
213 while (isdigit ((unsigned char) *pc))
220 /* imap_get_qualifier: in a tagged response, skip tag and status for
221 * the qualifier message. Used by imap_copy_message for TRYCREATE */
222 char *imap_get_qualifier (char *buf)
227 s = imap_next_word (s);
228 /* skip OK/NO/BAD response */
229 s = imap_next_word (s);
234 /* imap_next_word: return index into string where next IMAP word begins */
235 char *imap_next_word (char *s)
247 quoted = quoted ? 0 : 1;
248 if (!quoted && ISSPACE (*s))
253 return vskipspaces(s);
256 /* imap_parse_date: date is of the form: DD-MMM-YYYY HH:MM:SS +ZZzz */
257 time_t imap_parse_date(char *s)
264 loc = setlocale(LC_TIME, "C");
265 strptime(s, "%d-%b-%Y %T %z", &tm);
267 setlocale(LC_TIME, loc);
268 return timegm(&tm) + tz;
271 /* imap_qualify_path: make an absolute IMAP folder target, given IMAP_MBOX
272 * and relative path. */
273 void imap_qualify_path (char *dest, size_t len, IMAP_MBOX * mx, char *path)
277 mutt_account_tourl (&mx->account, &url);
280 url_ciss_tostring (&url, dest, len, 0);
284 /* imap_quote_string: quote string according to IMAP rules:
285 * surround string with quotes, escape " and \ with \ */
286 void imap_quote_string (char *dest, size_t dlen, const char *src)
288 char quote[] = "\"\\", *pt;
295 /* save room for trailing quote-char */
298 for (; *s && dlen; s++) {
299 if (strchr (quote, *s)) {
315 /* imap_unquote_string: equally stupid unquoting routine */
316 void imap_unquote_string (char *s)
343 * Quoting and UTF-7 conversion
346 void imap_munge_mbox_name (char *dest, size_t dlen, const char *src)
351 imap_utf7_encode (&buf);
353 imap_quote_string (dest, dlen, buf);
358 void imap_unmunge_mbox_name (char *s)
362 imap_unquote_string (s);
366 imap_utf7_decode (&buf);
367 m_strcpy(s, m_strlen(s) + 1, buf);
373 /* imap_wordcasecmp: find word a in word list b */
374 int imap_wordcasecmp (const char *a, const char *b)
377 char *s = (char *) b;
381 for (i = 0; i < STRING - 2; i++, s++) {
382 if (!*s || ISSPACE (*s)) {
390 return ascii_strcasecmp (a, tmp);
394 * Imap keepalive: poll the current folder to keep the
399 static void alrm_handler (int sig __attribute__((unused)))
404 void imap_keepalive (void)
410 conn = mutt_socket_head ();
412 if (conn->account.type == M_ACCT_TYPE_IMAP) {
413 idata = (IMAP_DATA *) conn->data;
415 if (idata->state >= IMAP_AUTHENTICATED
416 && time (NULL) >= idata->lastread + ImapKeepalive) {
420 ctx = p_new(CONTEXT, 1);
423 imap_check_mailbox (ctx, NULL, 1);
433 int imap_wait_keepalive (pid_t pid)
435 struct sigaction oldalrm;
436 struct sigaction act;
440 short imap_passive = option (OPTIMAPPASSIVE);
441 int imap_askreconnect = quadoption (OPT_IMAPRECONNECT);
443 set_option (OPTIMAPPASSIVE);
444 set_option (OPTKEEPQUIET);
445 set_quadoption (OPT_IMAPRECONNECT, M_NO);
447 sigprocmask (SIG_SETMASK, NULL, &oldmask);
449 sigemptyset (&act.sa_mask);
450 act.sa_handler = alrm_handler;
452 act.sa_flags = SA_INTERRUPT;
457 sigaction (SIGALRM, &act, &oldalrm);
459 alarm (ImapKeepalive);
460 while (waitpid (pid, &rc, 0) < 0 && errno == EINTR) {
461 alarm (0); /* cancel a possibly pending alarm */
463 alarm (ImapKeepalive);
466 alarm (0); /* cancel a possibly pending alarm */
468 sigaction (SIGALRM, &oldalrm, NULL);
469 sigprocmask (SIG_SETMASK, &oldmask, NULL);
471 unset_option (OPTKEEPQUIET);
473 unset_option (OPTIMAPPASSIVE);
474 set_quadoption (OPT_IMAPRECONNECT, imap_askreconnect);
479 /* Allow/disallow re-opening a folder upon expunge. */
481 void imap_allow_reopen (CONTEXT * ctx)
483 if (ctx && ctx->magic == M_IMAP && CTX_DATA->ctx == ctx)
484 CTX_DATA->reopen |= IMAP_REOPEN_ALLOW;
487 void imap_disallow_reopen (CONTEXT * ctx)
489 if (ctx && ctx->magic == M_IMAP && CTX_DATA->ctx == ctx)
490 CTX_DATA->reopen &= ~IMAP_REOPEN_ALLOW;