2 * Copyright (C) 1996-8 Michael R. Elkins <me@mutt.org>
3 * Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
4 * Copyright (C) 1999-2002 Brendan Cully <brendan@kublai.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
21 /* command.c: routines for sending commands to an IMAP server and parsing
29 #include "imap_private.h"
36 #define IMAP_CMD_BUFSIZE 512
38 /* forward declarations */
39 static void cmd_handle_fatal (IMAP_DATA * idata);
40 static int cmd_handle_untagged (IMAP_DATA * idata);
41 static void cmd_make_sequence (IMAP_DATA * idata);
42 static void cmd_parse_capabilities (IMAP_DATA * idata, char *s);
43 static void cmd_parse_expunge (IMAP_DATA * idata, const char *s);
44 static void cmd_parse_fetch (IMAP_DATA * idata, char *s);
45 static void cmd_parse_myrights (IMAP_DATA * idata, char *s);
47 static char *Capabilities[] = {
62 /* imap_cmd_start: Given an IMAP command, send it to the server.
63 * Currently a minor convenience, but helps to route all IMAP commands
64 * through a single interface. */
65 int imap_cmd_start (IMAP_DATA * idata, const char *cmd)
71 if (idata->status == IMAP_FATAL) {
72 cmd_handle_fatal (idata);
76 cmd_make_sequence (idata);
77 /* seq, space, cmd, \r\n\0 */
78 outlen = strlen (idata->cmd.seq) + strlen (cmd) + 4;
79 out = (char *) safe_malloc (outlen);
80 snprintf (out, outlen, "%s %s\r\n", idata->cmd.seq, cmd);
82 rc = mutt_socket_write (idata->conn, out);
86 return (rc < 0) ? IMAP_CMD_BAD : 0;
89 /* imap_cmd_step: Reads server responses from an IMAP command, detects
90 * tagged completion response, handles untagged messages, can read
91 * arbitrarily large strings (using malloc, so don't make it _too_
93 int imap_cmd_step (IMAP_DATA * idata)
95 IMAP_COMMAND *cmd = &idata->cmd;
99 if (idata->status == IMAP_FATAL) {
100 cmd_handle_fatal (idata);
104 /* read into buffer, expanding buffer as necessary until we have a full
107 if (len == cmd->blen) {
108 safe_realloc (&cmd->buf, cmd->blen + IMAP_CMD_BUFSIZE);
109 cmd->blen = cmd->blen + IMAP_CMD_BUFSIZE;
110 dprint (3, (debugfile, "imap_cmd_step: grew buffer to %u bytes\n",
114 c = mutt_socket_readln (cmd->buf + len, cmd->blen - len, idata->conn);
117 (debugfile, "imap_cmd_step: Error reading server response.\n"));
118 /* cmd_handle_fatal (idata); */
124 /* if we've read all the way to the end of the buffer, we haven't read a
125 * full line (mutt_socket_readln strips the \r, so we always have at least
126 * one character free when we've read a full line) */
127 while (len == cmd->blen);
129 /* don't let one large string make cmd->buf hog memory forever */
130 if ((cmd->blen > IMAP_CMD_BUFSIZE) && (len <= IMAP_CMD_BUFSIZE)) {
131 safe_realloc (&cmd->buf, IMAP_CMD_BUFSIZE);
132 cmd->blen = IMAP_CMD_BUFSIZE;
134 (debugfile, "imap_cmd_step: shrank buffer to %u bytes\n",
138 idata->lastread = time (NULL);
140 /* handle untagged messages. The caller still gets its shot afterwards. */
141 if (!ascii_strncmp (cmd->buf, "* ", 2) && cmd_handle_untagged (idata))
144 /* server demands a continuation response from us */
145 if (!ascii_strncmp (cmd->buf, "+ ", 2)) {
146 return IMAP_CMD_RESPOND;
149 /* tagged completion code */
150 if (!ascii_strncmp (cmd->buf, cmd->seq, SEQLEN)) {
151 imap_cmd_finish (idata);
152 return imap_code (cmd->buf) ? IMAP_CMD_OK : IMAP_CMD_NO;
155 return IMAP_CMD_CONTINUE;
158 /* imap_code: returns 1 if the command result was OK, or 0 if NO or BAD */
159 int imap_code (const char *s)
163 return (ascii_strncasecmp ("OK", s, 2) == 0);
166 /* imap_exec: execute a command, and wait for the response from the server.
167 * Also, handle untagged responses.
169 * IMAP_CMD_FAIL_OK: the calling procedure can handle failure. This is used
170 * for checking for a mailbox on append and login
171 * IMAP_CMD_PASS: command contains a password. Suppress logging.
172 * Return 0 on success, -1 on Failure, -2 on OK Failure
174 int imap_exec (IMAP_DATA * idata, const char *cmd, int flags)
180 if (idata->status == IMAP_FATAL) {
181 cmd_handle_fatal (idata);
185 /* create sequence for command */
186 cmd_make_sequence (idata);
187 /* seq, space, cmd, \r\n\0 */
188 outlen = strlen (idata->cmd.seq) + strlen (cmd) + 4;
189 out = (char *) safe_malloc (outlen);
190 snprintf (out, outlen, "%s %s\r\n", idata->cmd.seq, cmd);
192 rc = mutt_socket_write_d (idata->conn, out,
193 flags & IMAP_CMD_PASS ? IMAP_LOG_PASS :
198 cmd_handle_fatal (idata);
203 rc = imap_cmd_step (idata);
204 while (rc == IMAP_CMD_CONTINUE);
206 if (rc == IMAP_CMD_BAD) {
207 if (imap_reconnect (idata->ctx) != 0) {
213 if (rc == IMAP_CMD_NO && (flags & IMAP_CMD_FAIL_OK))
216 if (rc != IMAP_CMD_OK) {
217 if (flags & IMAP_CMD_FAIL_OK)
221 (debugfile, "imap_exec: command failed: %s\n", idata->cmd.buf));
228 /* imap_cmd_running: Returns whether an IMAP command is in progress. */
229 int imap_cmd_running (IMAP_DATA * idata)
231 if (idata->cmd.state == IMAP_CMD_CONTINUE ||
232 idata->cmd.state == IMAP_CMD_RESPOND)
238 /* imap_cmd_finish: Attempts to perform cleanup (eg fetch new mail if
239 * detected, do expunge). Called automatically by imap_cmd_step, but
240 * may be called at any time. Called by imap_check_mailbox just before
241 * the index is refreshed, for instance. */
242 void imap_cmd_finish (IMAP_DATA * idata)
244 if (idata->status == IMAP_FATAL) {
245 cmd_handle_fatal (idata);
249 if (!(idata->state == IMAP_SELECTED) || idata->ctx->closing)
252 if (idata->reopen & IMAP_REOPEN_ALLOW) {
253 int count = idata->newMailCount;
255 if (!(idata->reopen & IMAP_EXPUNGE_PENDING) &&
256 (idata->reopen & IMAP_NEWMAIL_PENDING)
257 && count > idata->ctx->msgcount) {
258 /* read new mail messages */
259 dprint (2, (debugfile, "imap_cmd_finish: Fetching new mail\n"));
260 /* check_status: curs_main uses imap_check_mailbox to detect
261 * whether the index needs updating */
262 idata->check_status = IMAP_NEWMAIL_PENDING;
263 imap_read_headers (idata, idata->ctx->msgcount, count - 1);
265 else if (idata->reopen & IMAP_EXPUNGE_PENDING) {
266 dprint (2, (debugfile, "imap_cmd_finish: Expunging mailbox\n"));
267 imap_expunge_mailbox (idata);
268 /* Detect whether we've gotten unexpected EXPUNGE messages */
269 if (idata->reopen & IMAP_EXPUNGE_PENDING &&
270 !(idata->reopen & IMAP_EXPUNGE_EXPECTED))
271 idata->check_status = IMAP_EXPUNGE_PENDING;
272 idata->reopen &= ~(IMAP_EXPUNGE_PENDING | IMAP_NEWMAIL_PENDING |
273 IMAP_EXPUNGE_EXPECTED);
280 /* cmd_handle_fatal: when IMAP_DATA is in fatal state, do what we can */
281 static void cmd_handle_fatal (IMAP_DATA * idata)
283 idata->status = IMAP_FATAL;
285 if ((idata->state == IMAP_SELECTED) &&
286 (idata->reopen & IMAP_REOPEN_ALLOW) && !idata->ctx->closing) {
287 /*mx_fastclose_mailbox (idata->ctx); */
288 mutt_error (_("Mailbox closed"));
290 idata->state = IMAP_DISCONNECTED;
291 if (imap_reconnect (idata->ctx) != 0)
292 mx_fastclose_mailbox (idata->ctx);
295 if (idata->state != IMAP_SELECTED) {
296 idata->state = IMAP_DISCONNECTED;
301 /* cmd_handle_untagged: fallback parser for otherwise unhandled messages. */
302 static int cmd_handle_untagged (IMAP_DATA * idata)
308 s = imap_next_word (idata->cmd.buf);
310 if ((idata->state == IMAP_SELECTED) && isdigit ((unsigned char) *s)) {
312 s = imap_next_word (s);
314 /* EXISTS and EXPUNGE are always related to the SELECTED mailbox for the
315 * connection, so update that one.
317 if (ascii_strncasecmp ("EXISTS", s, 6) == 0) {
318 dprint (2, (debugfile, "Handling EXISTS\n"));
320 /* new mail arrived */
323 if (!(idata->reopen & IMAP_EXPUNGE_PENDING) &&
324 count < idata->ctx->msgcount) {
325 /* something is wrong because the server reported fewer messages
326 * than we previously saw
328 mutt_error _("Fatal error. Message count is out of sync!");
330 idata->status = IMAP_FATAL;
333 /* at least the InterChange server sends EXISTS messages freely,
334 * even when there is no new mail */
335 else if (count == idata->ctx->msgcount)
336 dprint (3, (debugfile,
337 "cmd_handle_untagged: superfluous EXISTS message.\n"));
339 if (!(idata->reopen & IMAP_EXPUNGE_PENDING)) {
340 dprint (2, (debugfile,
341 "cmd_handle_untagged: New mail in %s - %d messages total.\n",
342 idata->mailbox, count));
343 idata->reopen |= IMAP_NEWMAIL_PENDING;
345 idata->newMailCount = count;
348 /* pn vs. s: need initial seqno */
349 else if (ascii_strncasecmp ("EXPUNGE", s, 7) == 0)
350 cmd_parse_expunge (idata, pn);
351 else if (ascii_strncasecmp ("FETCH", s, 5) == 0)
352 cmd_parse_fetch (idata, pn);
354 else if (ascii_strncasecmp ("CAPABILITY", s, 10) == 0)
355 cmd_parse_capabilities (idata, s);
356 else if (ascii_strncasecmp ("MYRIGHTS", s, 8) == 0)
357 cmd_parse_myrights (idata, s);
358 else if (ascii_strncasecmp ("BYE", s, 3) == 0) {
359 dprint (2, (debugfile, "Handling BYE\n"));
361 /* check if we're logging out */
362 if (idata->status == IMAP_BYE)
365 /* server shut down our connection */
368 mutt_error ("%s", s);
369 idata->status = IMAP_BYE;
371 /*if (imap_reconnect(idata->ctx)!=0) {
372 if (idata->state == IMAP_SELECTED)
373 mx_fastclose_mailbox (idata->ctx); *//* XXX memleak? */
374 mutt_socket_close (idata->conn);
375 idata->state = IMAP_DISCONNECTED;
381 else if (option (OPTIMAPSERVERNOISE)
382 && (ascii_strncasecmp ("NO", s, 2) == 0)) {
383 dprint (2, (debugfile, "Handling untagged NO\n"));
385 /* Display the warning message from the server */
386 mutt_error ("%s", s + 3);
393 /* cmd_make_sequence: make a tag suitable for starting an IMAP command */
394 static void cmd_make_sequence (IMAP_DATA * idata)
396 snprintf (idata->cmd.seq, sizeof (idata->cmd.seq), "a%04u", idata->seqno++);
398 if (idata->seqno > 9999)
402 /* cmd_parse_capabilities: set capability bits according to CAPABILITY
404 static void cmd_parse_capabilities (IMAP_DATA * idata, char *s)
408 dprint (2, (debugfile, "Handling CAPABILITY\n"));
410 s = imap_next_word (s);
411 FREE (&idata->capstr);
412 idata->capstr = safe_strdup (s);
414 memset (idata->capabilities, 0, sizeof (idata->capabilities));
417 for (x = 0; x < CAPMAX; x++)
418 if (imap_wordcasecmp (Capabilities[x], s) == 0) {
419 mutt_bit_set (idata->capabilities, x);
422 s = imap_next_word (s);
426 /* cmd_parse_expunge: mark headers with new sequence ID and mark idata to
427 * be reopened at our earliest convenience */
428 static void cmd_parse_expunge (IMAP_DATA * idata, const char *s)
433 dprint (2, (debugfile, "Handling EXPUNGE\n"));
437 /* walk headers, zero seqno of expunged message, decrement seqno of those
438 * above. Possibly we could avoid walking the whole list by resorting
439 * and guessing a good starting point, but I'm guessing the resort would
440 * nullify the gains */
441 for (cur = 0; cur < idata->ctx->msgcount; cur++) {
442 h = idata->ctx->hdrs[cur];
444 if (h->index + 1 == expno)
446 else if (h->index + 1 > expno)
450 idata->reopen |= IMAP_EXPUNGE_PENDING;
453 /* cmd_parse_fetch: Load fetch response into IMAP_DATA. Currently only
454 * handles unanticipated FETCH responses, and only FLAGS data. We get
455 * these if another client has changed flags for a mailbox we've selected.
456 * Of course, a lot of code here duplicates code in message.c. */
457 static void cmd_parse_fetch (IMAP_DATA * idata, char *s)
462 dprint (2, (debugfile, "Handling FETCH\n"));
466 if (msgno <= idata->ctx->msgcount)
467 /* see cmd_parse_expunge */
468 for (cur = 0; cur < idata->ctx->msgcount; cur++) {
469 h = idata->ctx->hdrs[cur];
471 if (h->active && h->index + 1 == msgno) {
473 (debugfile, "Message UID %d updated\n",
474 HEADER_DATA (h)->uid));
482 dprint (1, (debugfile, "FETCH response ignored for this message\n"));
487 s = imap_next_word (s);
488 s = imap_next_word (s);
491 dprint (1, (debugfile, "Malformed FETCH response"));
496 if (ascii_strncasecmp ("FLAGS", s, 5) != 0) {
497 dprint (2, (debugfile, "Only handle FLAGS updates\n"));
501 /* If server flags could conflict with mutt's flags, reopen the mailbox. */
503 idata->reopen |= IMAP_EXPUNGE_PENDING;
505 imap_set_flags (idata, h, s);
506 idata->check_status = IMAP_FLAGS_PENDING;
510 /* cmd_parse_myrights: set rights bits according to MYRIGHTS response */
511 static void cmd_parse_myrights (IMAP_DATA * idata, char *s)
513 dprint (2, (debugfile, "Handling MYRIGHTS\n"));
515 s = imap_next_word (s);
516 s = imap_next_word (s);
518 /* zero out current rights set */
519 memset (idata->rights, 0, sizeof (idata->rights));
521 while (*s && !isspace ((unsigned char) *s)) {
524 mutt_bit_set (idata->rights, IMAP_ACL_LOOKUP);
527 mutt_bit_set (idata->rights, IMAP_ACL_READ);
530 mutt_bit_set (idata->rights, IMAP_ACL_SEEN);
533 mutt_bit_set (idata->rights, IMAP_ACL_WRITE);
536 mutt_bit_set (idata->rights, IMAP_ACL_INSERT);
539 mutt_bit_set (idata->rights, IMAP_ACL_POST);
542 mutt_bit_set (idata->rights, IMAP_ACL_CREATE);
545 mutt_bit_set (idata->rights, IMAP_ACL_DELETE);
548 mutt_bit_set (idata->rights, IMAP_ACL_ADMIN);