1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
|
/*
* Copyright (C) 1996-1998,2010,2012 Michael R. Elkins <me@mutt.org>
* Copyright (C) 1996-1999 Brandon Long <blong@fiction.net>
* Copyright (C) 1999-2009,2011 Brendan Cully <brendan@kublai.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/* command.c: routines for sending commands to an IMAP server and parsing
* responses */
#if HAVE_CONFIG_H
# include "config.h"
#endif
#include "mutt.h"
#include "imap_private.h"
#include "mx.h"
#include "buffy.h"
#include <ctype.h>
#include <stdlib.h>
#define IMAP_CMD_BUFSIZE 512
/* forward declarations */
static int cmd_start (IMAP_DATA* idata, const char* cmdstr, int flags);
static int cmd_queue_full (IMAP_DATA* idata);
static int cmd_queue (IMAP_DATA* idata, const char* cmdstr);
static IMAP_COMMAND* cmd_new (IMAP_DATA* idata);
static int cmd_status (const char *s);
static void cmd_handle_fatal (IMAP_DATA* idata);
static int cmd_handle_untagged (IMAP_DATA* idata);
static void cmd_parse_capability (IMAP_DATA* idata, char* s);
static void cmd_parse_expunge (IMAP_DATA* idata, const char* s);
static void cmd_parse_list (IMAP_DATA* idata, char* s);
static void cmd_parse_lsub (IMAP_DATA* idata, char* s);
static void cmd_parse_fetch (IMAP_DATA* idata, char* s);
static void cmd_parse_myrights (IMAP_DATA* idata, const char* s);
static void cmd_parse_search (IMAP_DATA* idata, const char* s);
static void cmd_parse_status (IMAP_DATA* idata, char* s);
static void cmd_parse_enabled (IMAP_DATA* idata, const char* s);
static const char * const Capabilities[] = {
"IMAP4",
"IMAP4rev1",
"STATUS",
"ACL",
"NAMESPACE",
"AUTH=CRAM-MD5",
"AUTH=GSSAPI",
"AUTH=ANONYMOUS",
"STARTTLS",
"LOGINDISABLED",
"IDLE",
"SASL-IR",
"ENABLE",
NULL
};
/* imap_cmd_start: Given an IMAP command, send it to the server.
* If cmdstr is NULL, sends queued commands. */
int imap_cmd_start (IMAP_DATA* idata, const char* cmdstr)
{
return cmd_start (idata, cmdstr, 0);
}
/* imap_cmd_step: Reads server responses from an IMAP command, detects
* tagged completion response, handles untagged messages, can read
* arbitrarily large strings (using malloc, so don't make it _too_
* large!). */
int imap_cmd_step (IMAP_DATA* idata)
{
size_t len = 0;
int c;
int rc;
int stillrunning = 0;
IMAP_COMMAND* cmd;
if (idata->status == IMAP_FATAL)
{
cmd_handle_fatal (idata);
return IMAP_CMD_BAD;
}
/* read into buffer, expanding buffer as necessary until we have a full
* line */
do
{
if (len == idata->blen)
{
safe_realloc (&idata->buf, idata->blen + IMAP_CMD_BUFSIZE);
idata->blen = idata->blen + IMAP_CMD_BUFSIZE;
dprint (3, (debugfile, "imap_cmd_step: grew buffer to %u bytes\n",
idata->blen));
}
/* back up over '\0' */
if (len)
len--;
c = mutt_socket_readln (idata->buf + len, idata->blen - len, idata->conn);
if (c <= 0)
{
dprint (1, (debugfile, "imap_cmd_step: Error reading server response.\n"));
cmd_handle_fatal (idata);
return IMAP_CMD_BAD;
}
len += c;
}
/* if we've read all the way to the end of the buffer, we haven't read a
* full line (mutt_socket_readln strips the \r, so we always have at least
* one character free when we've read a full line) */
while (len == idata->blen);
/* don't let one large string make cmd->buf hog memory forever */
if ((idata->blen > IMAP_CMD_BUFSIZE) && (len <= IMAP_CMD_BUFSIZE))
{
safe_realloc (&idata->buf, IMAP_CMD_BUFSIZE);
idata->blen = IMAP_CMD_BUFSIZE;
dprint (3, (debugfile, "imap_cmd_step: shrank buffer to %u bytes\n", idata->blen));
}
idata->lastread = time (NULL);
/* handle untagged messages. The caller still gets its shot afterwards. */
if ((!ascii_strncmp (idata->buf, "* ", 2)
|| !ascii_strncmp (imap_next_word (idata->buf), "OK [", 4))
&& cmd_handle_untagged (idata))
return IMAP_CMD_BAD;
/* server demands a continuation response from us */
if (idata->buf[0] == '+')
return IMAP_CMD_RESPOND;
/* look for tagged command completions */
rc = IMAP_CMD_CONTINUE;
c = idata->lastcmd;
do
{
cmd = &idata->cmds[c];
if (cmd->state == IMAP_CMD_NEW)
{
if (!ascii_strncmp (idata->buf, cmd->seq, SEQLEN)) {
if (!stillrunning)
{
/* first command in queue has finished - move queue pointer up */
idata->lastcmd = (idata->lastcmd + 1) % idata->cmdslots;
}
cmd->state = cmd_status (idata->buf);
/* bogus - we don't know which command result to return here. Caller
* should provide a tag. */
rc = cmd->state;
}
else
stillrunning++;
}
c = (c + 1) % idata->cmdslots;
}
while (c != idata->nextcmd);
if (stillrunning)
rc = IMAP_CMD_CONTINUE;
else
{
dprint (3, (debugfile, "IMAP queue drained\n"));
imap_cmd_finish (idata);
}
return rc;
}
/* imap_code: returns 1 if the command result was OK, or 0 if NO or BAD */
int imap_code (const char *s)
{
return cmd_status (s) == IMAP_CMD_OK;
}
/* imap_cmd_trailer: extra information after tagged command response if any */
const char* imap_cmd_trailer (IMAP_DATA* idata)
{
static const char* notrailer = "";
const char* s = idata->buf;
if (!s)
{
dprint (2, (debugfile, "imap_cmd_trailer: not a tagged response"));
return notrailer;
}
s = imap_next_word ((char *)s);
if (!s || (ascii_strncasecmp (s, "OK", 2) &&
ascii_strncasecmp (s, "NO", 2) &&
ascii_strncasecmp (s, "BAD", 3)))
{
dprint (2, (debugfile, "imap_cmd_trailer: not a command completion: %s",
idata->buf));
return notrailer;
}
s = imap_next_word ((char *)s);
if (!s)
return notrailer;
return s;
}
/* imap_exec: execute a command, and wait for the response from the server.
* Also, handle untagged responses.
* Flags:
* IMAP_CMD_FAIL_OK: the calling procedure can handle failure. This is used
* for checking for a mailbox on append and login
* IMAP_CMD_PASS: command contains a password. Suppress logging.
* IMAP_CMD_QUEUE: only queue command, do not execute.
* Return 0 on success, -1 on Failure, -2 on OK Failure
*/
int imap_exec (IMAP_DATA* idata, const char* cmdstr, int flags)
{
int rc;
if ((rc = cmd_start (idata, cmdstr, flags)) < 0)
{
cmd_handle_fatal (idata);
return -1;
}
if (flags & IMAP_CMD_QUEUE)
return 0;
// Allow interruptions, particularly useful if there are network problems.
mutt_allow_interrupt (1);
do
rc = imap_cmd_step (idata);
while (rc == IMAP_CMD_CONTINUE);
mutt_allow_interrupt (0);
if (rc == IMAP_CMD_NO && (flags & IMAP_CMD_FAIL_OK))
return -2;
if (rc != IMAP_CMD_OK)
{
if ((flags & IMAP_CMD_FAIL_OK) && idata->status != IMAP_FATAL)
return -2;
dprint (1, (debugfile, "imap_exec: command failed: %s\n", idata->buf));
return -1;
}
return 0;
}
/* imap_cmd_finish: Attempts to perform cleanup (eg fetch new mail if
* detected, do expunge). Called automatically by imap_cmd_step, but
* may be called at any time. Called by imap_check_mailbox just before
* the index is refreshed, for instance. */
void imap_cmd_finish (IMAP_DATA* idata)
{
if (idata->status == IMAP_FATAL)
{
cmd_handle_fatal (idata);
return;
}
if (!(idata->state >= IMAP_SELECTED) || idata->ctx->closing)
return;
if (idata->reopen & IMAP_REOPEN_ALLOW)
{
int count = idata->newMailCount;
if (!(idata->reopen & IMAP_EXPUNGE_PENDING) &&
(idata->reopen & IMAP_NEWMAIL_PENDING)
&& count > idata->ctx->msgcount)
{
/* read new mail messages */
dprint (2, (debugfile, "imap_cmd_finish: Fetching new mail\n"));
/* check_status: curs_main uses imap_check_mailbox to detect
* whether the index needs updating */
idata->check_status = IMAP_NEWMAIL_PENDING;
imap_read_headers (idata, idata->ctx->msgcount, count-1);
}
else if (idata->reopen & IMAP_EXPUNGE_PENDING)
{
dprint (2, (debugfile, "imap_cmd_finish: Expunging mailbox\n"));
imap_expunge_mailbox (idata);
/* Detect whether we've gotten unexpected EXPUNGE messages */
if ((idata->reopen & IMAP_EXPUNGE_PENDING) &&
!(idata->reopen & IMAP_EXPUNGE_EXPECTED))
idata->check_status = IMAP_EXPUNGE_PENDING;
idata->reopen &= ~(IMAP_EXPUNGE_PENDING | IMAP_NEWMAIL_PENDING |
IMAP_EXPUNGE_EXPECTED);
}
}
idata->status = 0;
}
/* imap_cmd_idle: Enter the IDLE state. */
int imap_cmd_idle (IMAP_DATA* idata)
{
int rc;
imap_cmd_start (idata, "IDLE");
do
rc = imap_cmd_step (idata);
while (rc == IMAP_CMD_CONTINUE);
if (rc == IMAP_CMD_RESPOND)
{
/* successfully entered IDLE state */
idata->state = IMAP_IDLE;
/* queue automatic exit when next command is issued */
mutt_buffer_printf (idata->cmdbuf, "DONE\r\n");
rc = IMAP_CMD_OK;
}
if (rc != IMAP_CMD_OK)
{
dprint (1, (debugfile, "imap_cmd_idle: error starting IDLE\n"));
return -1;
}
return 0;
}
static int cmd_queue_full (IMAP_DATA* idata)
{
if ((idata->nextcmd + 1) % idata->cmdslots == idata->lastcmd)
return 1;
return 0;
}
/* sets up a new command control block and adds it to the queue.
* Returns NULL if the pipeline is full. */
static IMAP_COMMAND* cmd_new (IMAP_DATA* idata)
{
IMAP_COMMAND* cmd;
if (cmd_queue_full (idata))
{
dprint (3, (debugfile, "cmd_new: IMAP command queue full\n"));
return NULL;
}
cmd = idata->cmds + idata->nextcmd;
idata->nextcmd = (idata->nextcmd + 1) % idata->cmdslots;
snprintf (cmd->seq, sizeof (cmd->seq), "a%04u", idata->seqno++);
if (idata->seqno > 9999)
idata->seqno = 0;
cmd->state = IMAP_CMD_NEW;
return cmd;
}
/* queues command. If the queue is full, attempts to drain it. */
static int cmd_queue (IMAP_DATA* idata, const char* cmdstr)
{
IMAP_COMMAND* cmd;
int rc;
if (cmd_queue_full (idata))
{
dprint (3, (debugfile, "Draining IMAP command pipeline\n"));
rc = imap_exec (idata, NULL, IMAP_CMD_FAIL_OK);
if (rc < 0 && rc != -2)
return rc;
}
if (!(cmd = cmd_new (idata)))
return IMAP_CMD_BAD;
if (mutt_buffer_printf (idata->cmdbuf, "%s %s\r\n", cmd->seq, cmdstr) < 0)
return IMAP_CMD_BAD;
return 0;
}
static int cmd_start (IMAP_DATA* idata, const char* cmdstr, int flags)
{
int rc;
if (idata->status == IMAP_FATAL)
{
cmd_handle_fatal (idata);
return -1;
}
if (cmdstr && ((rc = cmd_queue (idata, cmdstr)) < 0))
return rc;
if (flags & IMAP_CMD_QUEUE)
return 0;
if (idata->cmdbuf->dptr == idata->cmdbuf->data)
return IMAP_CMD_BAD;
rc = mutt_socket_write_d (idata->conn, idata->cmdbuf->data, -1,
flags & IMAP_CMD_PASS ? IMAP_LOG_PASS : IMAP_LOG_CMD);
idata->cmdbuf->dptr = idata->cmdbuf->data;
/* unidle when command queue is flushed */
if (idata->state == IMAP_IDLE)
idata->state = IMAP_SELECTED;
return (rc < 0) ? IMAP_CMD_BAD : 0;
}
/* parse response line for tagged OK/NO/BAD */
static int cmd_status (const char *s)
{
s = imap_next_word((char*)s);
if (!ascii_strncasecmp("OK", s, 2))
return IMAP_CMD_OK;
if (!ascii_strncasecmp("NO", s, 2))
return IMAP_CMD_NO;
return IMAP_CMD_BAD;
}
/* cmd_handle_fatal: when IMAP_DATA is in fatal state, do what we can */
static void cmd_handle_fatal (IMAP_DATA* idata)
{
idata->status = IMAP_FATAL;
if ((idata->state >= IMAP_SELECTED) &&
(idata->reopen & IMAP_REOPEN_ALLOW))
{
mx_fastclose_mailbox (idata->ctx);
mutt_error (_("Mailbox closed"));
mutt_sleep (1);
idata->state = IMAP_DISCONNECTED;
}
if (idata->state < IMAP_SELECTED)
imap_close_connection (idata);
}
/* cmd_handle_untagged: fallback parser for otherwise unhandled messages. */
static int cmd_handle_untagged (IMAP_DATA* idata)
{
char* s;
char* pn;
int count;
s = imap_next_word (idata->buf);
pn = imap_next_word (s);
if ((idata->state >= IMAP_SELECTED) && isdigit ((unsigned char) *s))
{
pn = s;
s = imap_next_word (s);
/* EXISTS and EXPUNGE are always related to the SELECTED mailbox for the
* connection, so update that one.
*/
if (ascii_strncasecmp ("EXISTS", s, 6) == 0)
{
dprint (2, (debugfile, "Handling EXISTS\n"));
/* new mail arrived */
count = atoi (pn);
if ( !(idata->reopen & IMAP_EXPUNGE_PENDING) &&
count < idata->ctx->msgcount)
{
/* Notes 6.0.3 has a tendency to report fewer messages exist than
* it should. */
dprint (1, (debugfile, "Message count is out of sync"));
return 0;
}
/* at least the InterChange server sends EXISTS messages freely,
* even when there is no new mail */
else if (count == idata->ctx->msgcount)
dprint (3, (debugfile,
"cmd_handle_untagged: superfluous EXISTS message.\n"));
else
{
if (!(idata->reopen & IMAP_EXPUNGE_PENDING))
{
dprint (2, (debugfile,
"cmd_handle_untagged: New mail in %s - %d messages total.\n",
idata->mailbox, count));
idata->reopen |= IMAP_NEWMAIL_PENDING;
}
idata->newMailCount = count;
}
}
/* pn vs. s: need initial seqno */
else if (ascii_strncasecmp ("EXPUNGE", s, 7) == 0)
cmd_parse_expunge (idata, pn);
else if (ascii_strncasecmp ("FETCH", s, 5) == 0)
cmd_parse_fetch (idata, pn);
}
else if (ascii_strncasecmp ("CAPABILITY", s, 10) == 0)
cmd_parse_capability (idata, s);
else if (!ascii_strncasecmp ("OK [CAPABILITY", s, 14))
cmd_parse_capability (idata, pn);
else if (!ascii_strncasecmp ("OK [CAPABILITY", pn, 14))
cmd_parse_capability (idata, imap_next_word (pn));
else if (ascii_strncasecmp ("LIST", s, 4) == 0)
cmd_parse_list (idata, s);
else if (ascii_strncasecmp ("LSUB", s, 4) == 0)
cmd_parse_lsub (idata, s);
else if (ascii_strncasecmp ("MYRIGHTS", s, 8) == 0)
cmd_parse_myrights (idata, s);
else if (ascii_strncasecmp ("SEARCH", s, 6) == 0)
cmd_parse_search (idata, s);
else if (ascii_strncasecmp ("STATUS", s, 6) == 0)
cmd_parse_status (idata, s);
else if (ascii_strncasecmp ("ENABLED", s, 7) == 0)
cmd_parse_enabled (idata, s);
else if (ascii_strncasecmp ("BYE", s, 3) == 0)
{
dprint (2, (debugfile, "Handling BYE\n"));
/* check if we're logging out */
if (idata->status == IMAP_BYE)
return 0;
/* server shut down our connection */
s += 3;
SKIPWS (s);
mutt_error ("%s", s);
mutt_sleep (2);
cmd_handle_fatal (idata);
return -1;
}
else if (option (OPTIMAPSERVERNOISE) && (ascii_strncasecmp ("NO", s, 2) == 0))
{
dprint (2, (debugfile, "Handling untagged NO\n"));
/* Display the warning message from the server */
mutt_error ("%s", s+2);
mutt_sleep (2);
}
return 0;
}
/* cmd_parse_capabilities: set capability bits according to CAPABILITY
* response */
static void cmd_parse_capability (IMAP_DATA* idata, char* s)
{
int x;
char* bracket;
dprint (3, (debugfile, "Handling CAPABILITY\n"));
s = imap_next_word (s);
if ((bracket = strchr (s, ']')))
*bracket = '\0';
FREE(&idata->capstr);
idata->capstr = safe_strdup (s);
memset (idata->capabilities, 0, sizeof (idata->capabilities));
while (*s)
{
for (x = 0; x < CAPMAX; x++)
if (imap_wordcasecmp(Capabilities[x], s) == 0)
{
mutt_bit_set (idata->capabilities, x);
break;
}
s = imap_next_word (s);
}
}
/* cmd_parse_expunge: mark headers with new sequence ID and mark idata to
* be reopened at our earliest convenience */
static void cmd_parse_expunge (IMAP_DATA* idata, const char* s)
{
int expno, cur;
HEADER* h;
dprint (2, (debugfile, "Handling EXPUNGE\n"));
expno = atoi (s);
/* walk headers, zero seqno of expunged message, decrement seqno of those
* above. Possibly we could avoid walking the whole list by resorting
* and guessing a good starting point, but I'm guessing the resort would
* nullify the gains */
for (cur = 0; cur < idata->ctx->msgcount; cur++)
{
h = idata->ctx->hdrs[cur];
if (h->index+1 == expno)
h->index = -1;
else if (h->index+1 > expno)
h->index--;
}
idata->reopen |= IMAP_EXPUNGE_PENDING;
}
/* cmd_parse_fetch: Load fetch response into IMAP_DATA. Currently only
* handles unanticipated FETCH responses, and only FLAGS data. We get
* these if another client has changed flags for a mailbox we've selected.
* Of course, a lot of code here duplicates code in message.c. */
static void cmd_parse_fetch (IMAP_DATA* idata, char* s)
{
int msgno, cur;
HEADER* h = NULL;
dprint (3, (debugfile, "Handling FETCH\n"));
msgno = atoi (s);
if (msgno <= idata->ctx->msgcount)
/* see cmd_parse_expunge */
for (cur = 0; cur < idata->ctx->msgcount; cur++)
{
h = idata->ctx->hdrs[cur];
if (h && h->active && h->index+1 == msgno)
{
dprint (2, (debugfile, "Message UID %d updated\n", HEADER_DATA(h)->uid));
break;
}
h = NULL;
}
if (!h)
{
dprint (3, (debugfile, "FETCH response ignored for this message\n"));
return;
}
/* skip FETCH */
s = imap_next_word (s);
s = imap_next_word (s);
if (*s != '(')
{
dprint (1, (debugfile, "Malformed FETCH response"));
return;
}
s++;
if (ascii_strncasecmp ("FLAGS", s, 5) != 0)
{
dprint (2, (debugfile, "Only handle FLAGS updates\n"));
return;
}
/* If server flags could conflict with mutt's flags, reopen the mailbox. */
if (h->changed)
idata->reopen |= IMAP_EXPUNGE_PENDING;
else {
imap_set_flags (idata, h, s);
idata->check_status = IMAP_FLAGS_PENDING;
}
}
static void cmd_parse_list (IMAP_DATA* idata, char* s)
{
IMAP_LIST* list;
IMAP_LIST lb;
char delimbuf[5]; /* worst case: "\\"\0 */
long litlen;
if (idata->cmddata && idata->cmdtype == IMAP_CT_LIST)
list = (IMAP_LIST*)idata->cmddata;
else
list = &lb;
memset (list, 0, sizeof (IMAP_LIST));
/* flags */
s = imap_next_word (s);
if (*s != '(')
{
dprint (1, (debugfile, "Bad LIST response\n"));
return;
}
s++;
while (*s)
{
if (!ascii_strncasecmp (s, "\\NoSelect", 9))
list->noselect = 1;
else if (!ascii_strncasecmp (s, "\\NoInferiors", 12))
list->noinferiors = 1;
/* See draft-gahrns-imap-child-mailbox-?? */
else if (!ascii_strncasecmp (s, "\\HasNoChildren", 14))
list->noinferiors = 1;
s = imap_next_word (s);
if (*(s - 2) == ')')
break;
}
/* Delimiter */
if (ascii_strncasecmp (s, "NIL", 3))
{
delimbuf[0] = '\0';
safe_strcat (delimbuf, 5, s);
imap_unquote_string (delimbuf);
list->delim = delimbuf[0];
}
/* Name */
s = imap_next_word (s);
/* Notes often responds with literals here. We need a real tokenizer. */
if (!imap_get_literal_count (s, &litlen))
{
if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE)
{
idata->status = IMAP_FATAL;
return;
}
list->name = idata->buf;
}
else
{
imap_unmunge_mbox_name (idata, s);
list->name = s;
}
if (list->name[0] == '\0')
{
idata->delim = list->delim;
dprint (3, (debugfile, "Root delimiter: %c\n", idata->delim));
}
}
static void cmd_parse_lsub (IMAP_DATA* idata, char* s)
{
char buf[STRING];
char errstr[STRING];
BUFFER err, token;
ciss_url_t url;
IMAP_LIST list;
if (idata->cmddata && idata->cmdtype == IMAP_CT_LIST)
{
/* caller will handle response itself */
cmd_parse_list (idata, s);
return;
}
if (!option (OPTIMAPCHECKSUBSCRIBED))
return;
idata->cmdtype = IMAP_CT_LIST;
idata->cmddata = &list;
cmd_parse_list (idata, s);
idata->cmddata = NULL;
/* noselect is for a gmail quirk (#3445) */
if (!list.name || list.noselect)
return;
dprint (3, (debugfile, "Subscribing to %s\n", list.name));
strfcpy (buf, "mailboxes \"", sizeof (buf));
mutt_account_tourl (&idata->conn->account, &url);
/* escape \ and ". Also escape ` because the resulting
* string will be passed to mutt_parse_rc_line. */
imap_quote_string_and_backquotes (errstr, sizeof (errstr), list.name);
url.path = errstr + 1;
url.path[strlen(url.path) - 1] = '\0';
if (!mutt_strcmp (url.user, ImapUser))
url.user = NULL;
url_ciss_tostring (&url, buf + 11, sizeof (buf) - 11, 0);
safe_strcat (buf, sizeof (buf), "\"");
mutt_buffer_init (&token);
mutt_buffer_init (&err);
err.data = errstr;
err.dsize = sizeof (errstr);
if (mutt_parse_rc_line (buf, &token, &err))
dprint (1, (debugfile, "Error adding subscribed mailbox: %s\n", errstr));
FREE (&token.data);
}
/* cmd_parse_myrights: set rights bits according to MYRIGHTS response */
static void cmd_parse_myrights (IMAP_DATA* idata, const char* s)
{
dprint (2, (debugfile, "Handling MYRIGHTS\n"));
s = imap_next_word ((char*)s);
s = imap_next_word ((char*)s);
/* zero out current rights set */
memset (idata->ctx->rights, 0, sizeof (idata->ctx->rights));
while (*s && !isspace((unsigned char) *s))
{
switch (*s)
{
case 'l':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_LOOKUP);
break;
case 'r':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_READ);
break;
case 's':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_SEEN);
break;
case 'w':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_WRITE);
break;
case 'i':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_INSERT);
break;
case 'p':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_POST);
break;
case 'a':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_ADMIN);
break;
case 'k':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_CREATE);
break;
case 'x':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_DELMX);
break;
case 't':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_DELETE);
break;
case 'e':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_EXPUNGE);
break;
/* obsolete rights */
case 'c':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_CREATE);
mutt_bit_set (idata->ctx->rights, MUTT_ACL_DELMX);
break;
case 'd':
mutt_bit_set (idata->ctx->rights, MUTT_ACL_DELETE);
mutt_bit_set (idata->ctx->rights, MUTT_ACL_EXPUNGE);
break;
default:
dprint(1, (debugfile, "Unknown right: %c\n", *s));
}
s++;
}
}
/* This should be optimised (eg with a tree or hash) */
static int uid2msgno (IMAP_DATA* idata, unsigned int uid)
{
int i;
for (i = 0; i < idata->ctx->msgcount; i++)
{
HEADER* h = idata->ctx->hdrs[i];
if (HEADER_DATA(h)->uid == uid)
return i;
}
return -1;
}
/* cmd_parse_search: store SEARCH response for later use */
static void cmd_parse_search (IMAP_DATA* idata, const char* s)
{
unsigned int uid;
int msgno;
dprint (2, (debugfile, "Handling SEARCH\n"));
while ((s = imap_next_word ((char*)s)) && *s != '\0')
{
uid = atoi (s);
msgno = uid2msgno (idata, uid);
if (msgno >= 0)
idata->ctx->hdrs[uid2msgno (idata, uid)]->matched = 1;
}
}
/* first cut: just do buffy update. Later we may wish to cache all
* mailbox information, even that not desired by buffy */
static void cmd_parse_status (IMAP_DATA* idata, char* s)
{
char* mailbox;
char* value;
BUFFY* inc;
IMAP_MBOX mx;
int count;
IMAP_STATUS *status;
unsigned int olduv, oldun;
long litlen;
short new = 0;
short new_msg_count = 0;
mailbox = imap_next_word (s);
/* We need a real tokenizer. */
if (!imap_get_literal_count (mailbox, &litlen))
{
if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE)
{
idata->status = IMAP_FATAL;
return;
}
if (strlen(idata->buf) < litlen)
{
dprint (1, (debugfile, "Error parsing STATUS mailbox\n"));
return;
}
mailbox = idata->buf;
s = mailbox + litlen;
*s = '\0';
s++;
SKIPWS(s);
}
else
{
s = imap_next_word (mailbox);
*(s - 1) = '\0';
imap_unmunge_mbox_name (idata, mailbox);
}
status = imap_mboxcache_get (idata, mailbox, 1);
olduv = status->uidvalidity;
oldun = status->uidnext;
if (*s++ != '(')
{
dprint (1, (debugfile, "Error parsing STATUS\n"));
return;
}
while (*s && *s != ')')
{
value = imap_next_word (s);
count = strtol (value, &value, 10);
if (!ascii_strncmp ("MESSAGES", s, 8))
{
status->messages = count;
new_msg_count = 1;
}
else if (!ascii_strncmp ("RECENT", s, 6))
status->recent = count;
else if (!ascii_strncmp ("UIDNEXT", s, 7))
status->uidnext = count;
else if (!ascii_strncmp ("UIDVALIDITY", s, 11))
status->uidvalidity = count;
else if (!ascii_strncmp ("UNSEEN", s, 6))
status->unseen = count;
s = value;
if (*s && *s != ')')
s = imap_next_word (s);
}
dprint (3, (debugfile, "%s (UIDVALIDITY: %d, UIDNEXT: %d) %d messages, %d recent, %d unseen\n",
status->name, status->uidvalidity, status->uidnext,
status->messages, status->recent, status->unseen));
/* caller is prepared to handle the result herself */
if (idata->cmddata && idata->cmdtype == IMAP_CT_STATUS)
{
memcpy (idata->cmddata, status, sizeof (IMAP_STATUS));
return;
}
dprint (3, (debugfile, "Running default STATUS handler\n"));
/* should perhaps move this code back to imap_buffy_check */
for (inc = Incoming; inc; inc = inc->next)
{
if (inc->magic != MUTT_IMAP)
continue;
if (imap_parse_path (inc->path, &mx) < 0)
{
dprint (1, (debugfile, "Error parsing mailbox %s, skipping\n", inc->path));
continue;
}
/* dprint (2, (debugfile, "Buffy entry: [%s] mbox: [%s]\n", inc->path, NONULL(mx.mbox))); */
if (imap_account_match (&idata->conn->account, &mx.account))
{
if (mx.mbox)
{
value = safe_strdup (mx.mbox);
imap_fix_path (idata, mx.mbox, value, mutt_strlen (value) + 1);
FREE (&mx.mbox);
}
else
value = safe_strdup ("INBOX");
if (value && !imap_mxcmp (mailbox, value))
{
dprint (3, (debugfile, "Found %s in buffy list (OV: %d ON: %d U: %d)\n",
mailbox, olduv, oldun, status->unseen));
if (option(OPTMAILCHECKRECENT))
{
if (olduv && olduv == status->uidvalidity)
{
if (oldun < status->uidnext)
new = (status->unseen > 0);
}
else if (!olduv && !oldun)
/* first check per session, use recent. might need a flag for this. */
new = (status->recent > 0);
else
new = (status->unseen > 0);
}
else
new = (status->unseen > 0);
#ifdef USE_SIDEBAR
if ((inc->new != new) ||
(inc->msg_count != status->messages) ||
(inc->msg_unread != status->unseen))
SidebarNeedsRedraw = 1;
#endif
inc->new = new;
if (new_msg_count)
inc->msg_count = status->messages;
inc->msg_unread = status->unseen;
if (inc->new)
/* force back to keep detecting new mail until the mailbox is
opened */
status->uidnext = oldun;
FREE (&value);
return;
}
FREE (&value);
}
FREE (&mx.mbox);
}
}
/* cmd_parse_enabled: record what the server has enabled */
static void cmd_parse_enabled (IMAP_DATA* idata, const char* s)
{
dprint (2, (debugfile, "Handling ENABLED\n"));
while ((s = imap_next_word ((char*)s)) && *s != '\0')
{
if (ascii_strncasecmp(s, "UTF8=ACCEPT", 11) == 0 ||
ascii_strncasecmp(s, "UTF8=ONLY", 9) == 0)
idata->unicode = 1;
}
}
|