citadel/modules/imap/imap_fetch.c

   1 /*
   2  * $Id$
   3  *
   4  * Implements the FETCH command in IMAP.
   5  * This is a good example of the protocol's gratuitous complexity.
   6  *
   7  * Copyright (c) 2001-2009 by the citadel.org team
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 3 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with this program; if not, write to the Free Software
  21  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24
  25 #include "sysdep.h"
  26 #include <stdlib.h>
  27 #include <unistd.h>
  28 #include <stdio.h>
  29 #include <fcntl.h>
  30 #include <signal.h>
  31 #include <pwd.h>
  32 #include <errno.h>
  33 #include <sys/types.h>
  34
  35 #if TIME_WITH_SYS_TIME
  36 # include <sys/time.h>
  37 # include <time.h>
  38 #else
  39 # if HAVE_SYS_TIME_H
  40 #  include <sys/time.h>
  41 # else
  42 #  include <time.h>
  43 # endif
  44 #endif
  45
  46 #include <sys/wait.h>
  47 #include <ctype.h>
  48 #include <string.h>
  49 #include <limits.h>
  50 #include <libcitadel.h>
  51 #include "citadel.h"
  52 #include "server.h"
  53 #include "sysdep_decls.h"
  54 #include "citserver.h"
  55 #include "support.h"
  56 #include "config.h"
  57 #include "user_ops.h"
  58 #include "database.h"
  59 #include "msgbase.h"
  60 #include "internet_addressing.h"
  61 #include "imap_tools.h"
  62 #include "serv_imap.h"
  63 #include "imap_fetch.h"
  64 #include "genstamp.h"
  65 #include "ctdl_module.h"
  66
  67
  68
  69 /*
  70  * Individual field functions for imap_do_fetch_msg() ...
  71  */
  72
  73 void imap_fetch_uid(int seq) {
  74         cprintf("UID %ld", IMAP->msgids[seq-1]);
  75 }
  76
  77 void imap_fetch_flags(int seq) {
  78         int num_flags_printed = 0;
  79         cprintf("FLAGS (");
  80         if (IMAP->flags[seq] & IMAP_DELETED) {
  81                 if (num_flags_printed > 0) cprintf(" ");
  82                 cprintf("\\Deleted");
  83                 ++num_flags_printed;
  84         }
  85         if (IMAP->flags[seq] & IMAP_SEEN) {
  86                 if (num_flags_printed > 0) cprintf(" ");
  87                 cprintf("\\Seen");
  88                 ++num_flags_printed;
  89         }
  90         if (IMAP->flags[seq] & IMAP_ANSWERED) {
  91                 if (num_flags_printed > 0) cprintf(" ");
  92                 cprintf("\\Answered");
  93                 ++num_flags_printed;
  94         }
  95         if (IMAP->flags[seq] & IMAP_RECENT) {
  96                 if (num_flags_printed > 0) cprintf(" ");
  97                 cprintf("\\Recent");
  98                 ++num_flags_printed;
  99         }
 100         cprintf(")");
 101 }
 102
 103
 104 void imap_fetch_internaldate(struct CtdlMessage *msg) {
 105         char datebuf[64];
 106         time_t msgdate;
 107
 108         if (!msg) return;
 109         if (msg->cm_fields['T'] != NULL) {
 110                 msgdate = atol(msg->cm_fields['T']);
 111         }
 112         else {
 113                 msgdate = time(NULL);
 114         }
 115
 116         datestring(datebuf, sizeof datebuf, msgdate, DATESTRING_IMAP);
 117         cprintf("INTERNALDATE \"%s\"", datebuf);
 118 }
 119
 120
 121 /*
 122  * Fetch RFC822-formatted messages.
 123  *
 124  * 'whichfmt' should be set to one of:
 125  *      "RFC822"        entire message
 126  *      "RFC822.HEADER" headers only (with trailing blank line)
 127  *      "RFC822.SIZE"   size of translated message
 128  *      "RFC822.TEXT"   body only (without leading blank line)
 129  */
 130 void imap_fetch_rfc822(long msgnum, const char *whichfmt) {
 131         const char *ptr = NULL;
 132         size_t headers_size, text_size, total_size;
 133         size_t bytes_to_send = 0;
 134         struct MetaData smi;
 135         int need_to_rewrite_metadata = 0;
 136         int need_body = 0;
 137         CitContext *CCC = CC;
 138
 139         /* Determine whether this particular fetch operation requires
 140          * us to fetch the message body from disk.  If not, we can save
 141          * on some disk operations...
 142          */
 143         if ( (!strcasecmp(whichfmt, "RFC822"))
 144            || (!strcasecmp(whichfmt, "RFC822.TEXT")) ) {
 145                 need_body = 1;
 146         }
 147
 148         /* If this is an RFC822.SIZE fetch, first look in the message's
 149          * metadata record to see if we've saved that information.
 150          */
 151         if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
 152                 GetMetaData(&smi, msgnum);
 153                 if (smi.meta_rfc822_length > 0L) {
 154                         cprintf("RFC822.SIZE %ld", smi.meta_rfc822_length);
 155                         return;
 156                 }
 157                 need_to_rewrite_metadata = 1;
 158                 need_body = 1;
 159         }
 160
 161         /* Cache the most recent RFC822 FETCH because some clients like to
 162          * fetch in pieces, and we don't want to have to go back to the
 163          * message store for each piece.  We also burn the cache if the
 164          * client requests something that involves reading the message
 165          * body, but we haven't fetched the body yet.
 166          */
 167         if ((IMAP->cached_rfc822 != NULL)
 168            && (IMAP->cached_rfc822_msgnum == msgnum)
 169            && (IMAP->cached_rfc822_withbody || (!need_body)) ) {
 170                 /* Good to go! */
 171         }
 172         else if (IMAP->cached_rfc822 != NULL) {
 173                 /* Some other message is cached -- free it */
 174                 FreeStrBuf(&IMAP->cached_rfc822);
 175                 IMAP->cached_rfc822_msgnum = (-1);
 176         }
 177
 178         /* At this point, we now can fetch and convert the message iff it's not
 179          * the one we had cached.
 180          */
 181         if (IMAP->cached_rfc822 == NULL) {
 182                 /*
 183                  * Load the message into memory for translation & measurement
 184                  */
 185                 CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
 186                 CtdlOutputMsg(msgnum, MT_RFC822,
 187                         (need_body ? HEADERS_ALL : HEADERS_FAST),
 188                         0, 1, NULL, SUPPRESS_ENV_TO
 189                 );
 190                 if (!need_body) cprintf("\r\n");        /* extra trailing newline */
 191                 IMAP->cached_rfc822 = CCC->redirect_buffer;
 192                 CCC->redirect_buffer = NULL;
 193                 IMAP->cached_rfc822_msgnum = msgnum;
 194                 IMAP->cached_rfc822_withbody = need_body;
 195                 if ( (need_to_rewrite_metadata) &&
 196                      (StrLength(IMAP->cached_rfc822) > 0) ) {
 197                         smi.meta_rfc822_length = StrLength(IMAP->cached_rfc822);
 198                         PutMetaData(&smi);
 199                 }
 200         }
 201
 202         /*
 203          * Now figure out where the headers/text break is.  IMAP considers the
 204          * intervening blank line to be part of the headers, not the text.
 205          */
 206         headers_size = 0;
 207         text_size = 0;
 208         total_size = 0;
 209
 210         if (need_body) {
 211                 StrBuf *Line = NewStrBuf();
 212                 ptr = NULL;
 213                 do {
 214                         StrBufSipLine(Line, IMAP->cached_rfc822, &ptr);
 215
 216                         if ((StrLength(Line) != 0)  && (ptr != StrBufNOTNULL))
 217                         {
 218                                 StrBufTrim(Line);
 219                                 if ((StrLength(Line) != 0) &&
 220                                     (ptr != StrBufNOTNULL)    )
 221                                 {
 222                                         headers_size = ptr - ChrPtr(IMAP->cached_rfc822);
 223                                 }
 224                         }
 225                 } while ( (headers_size == 0)    &&
 226                           (ptr != StrBufNOTNULL) );
 227
 228                 total_size = StrLength(IMAP->cached_rfc822);
 229                 text_size = total_size - headers_size;
 230                 FreeStrBuf(&Line);
 231         }
 232         else {
 233                 headers_size =
 234                         total_size = StrLength(IMAP->cached_rfc822);
 235                 text_size = 0;
 236         }
 237
 238         CtdlLogPrintf(CTDL_DEBUG,
 239                 "RFC822: headers=" SIZE_T_FMT
 240                 ", text=" SIZE_T_FMT
 241                 ", total=" SIZE_T_FMT "\n",
 242                 headers_size, text_size, total_size);
 243
 244         if (!strcasecmp(whichfmt, "RFC822.SIZE")) {
 245                 cprintf("RFC822.SIZE " SIZE_T_FMT, total_size);
 246                 return;
 247         }
 248
 249         else if (!strcasecmp(whichfmt, "RFC822")) {
 250                 ptr = ChrPtr(IMAP->cached_rfc822);
 251                 bytes_to_send = total_size;
 252         }
 253
 254         else if (!strcasecmp(whichfmt, "RFC822.HEADER")) {
 255                 ptr = ChrPtr(IMAP->cached_rfc822);
 256                 bytes_to_send = headers_size;
 257         }
 258
 259         else if (!strcasecmp(whichfmt, "RFC822.TEXT")) {
 260                 ptr = &ChrPtr(IMAP->cached_rfc822)[headers_size];
 261                 bytes_to_send = text_size;
 262         }
 263
 264         cprintf("%s {" SIZE_T_FMT "}\r\n", whichfmt, bytes_to_send);
 265         client_write(ptr, bytes_to_send);
 266 }
 267
 268
 269
 270 /*
 271  * Load a specific part of a message into the temp file to be output to a
 272  * client.  FIXME we can handle parts like "2" and "2.1" and even "2.MIME"
 273  * but we still can't handle "2.HEADER" (which might not be a problem).
 274  *
 275  * Note: mime_parser() was called with dont_decode set to 1, so we have the
 276  * luxury of simply spewing without having to re-encode.
 277  */
 278 void imap_load_part(char *name, char *filename, char *partnum, char *disp,
 279                     void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
 280                     char *cbid, void *cbuserdata)
 281 {
 282         char mimebuf2[SIZ];
 283         char *desired_section;
 284
 285         desired_section = (char *)cbuserdata;
 286         CtdlLogPrintf(CTDL_DEBUG, "imap_load_part() looking for %s, found %s\n",
 287                 desired_section,
 288                 partnum
 289         );
 290
 291         if (!strcasecmp(partnum, desired_section)) {
 292                 client_write(content, length);
 293         }
 294
 295         snprintf(mimebuf2, sizeof mimebuf2, "%s.MIME", partnum);
 296
 297         if (!strcasecmp(desired_section, mimebuf2)) {
 298                 cprintf("Content-type: %s", cbtype);
 299                 if (!IsEmptyStr(cbcharset))
 300                         cprintf("; charset=\"%s\"", cbcharset);
 301                 if (!IsEmptyStr(name))
 302                         cprintf("; name=\"%s\"", name);
 303                 cprintf("\r\n");
 304                 if (!IsEmptyStr(encoding))
 305                         cprintf("Content-Transfer-Encoding: %s\r\n", encoding);
 306                 if (!IsEmptyStr(encoding)) {
 307                         cprintf("Content-Disposition: %s", disp);
 308                         if (!IsEmptyStr(filename)) {
 309                                 cprintf("; filename=\"%s\"", filename);
 310                         }
 311                         cprintf("\r\n");
 312                 }
 313                 cprintf("Content-Length: %ld\r\n", (long)length);
 314                 cprintf("\r\n");
 315         }
 316
 317
 318 }
 319
 320
 321 /*
 322  * Called by imap_fetch_envelope() to output the "From" field.
 323  * This is in its own function because its logic is kind of complex.  We
 324  * really need to make this suck less.
 325  */
 326 void imap_output_envelope_from(struct CtdlMessage *msg) {
 327         char user[SIZ], node[SIZ], name[SIZ];
 328
 329         if (!msg) return;
 330
 331         /* For anonymous messages, it's so easy! */
 332         if (!is_room_aide() && (msg->cm_anon_type == MES_ANONONLY)) {
 333                 cprintf("((\"----\" NIL \"x\" \"x.org\")) ");
 334                 return;
 335         }
 336         if (!is_room_aide() && (msg->cm_anon_type == MES_ANONOPT)) {
 337                 cprintf("((\"anonymous\" NIL \"x\" \"x.org\")) ");
 338                 return;
 339         }
 340
 341         /* For everything else, we do stuff. */
 342         cprintf("((");                          /* open double-parens */
 343         plain_imap_strout(msg->cm_fields['A']); /* personal name */
 344         cprintf(" NIL ");                       /* source route (not used) */
 345
 346
 347         if (msg->cm_fields['F'] != NULL) {
 348                 process_rfc822_addr(msg->cm_fields['F'], user, node, name);
 349                 plain_imap_strout(user);                /* mailbox name (user id) */
 350                 cprintf(" ");
 351                 if (!strcasecmp(node, config.c_nodename)) {
 352                         plain_imap_strout(config.c_fqdn);
 353                 }
 354                 else {
 355                         plain_imap_strout(node);                /* host name */
 356                 }
 357         }
 358         else {
 359                 plain_imap_strout(msg->cm_fields['A']); /* mailbox name (user id) */
 360                 cprintf(" ");
 361                 plain_imap_strout(msg->cm_fields['N']); /* host name */
 362         }
 363
 364         cprintf(")) ");                         /* close double-parens */
 365 }
 366
 367
 368
 369 /*
 370  * Output an envelope address (or set of addresses) in the official,
 371  * convoluted, braindead format.  (Note that we can't use this for
 372  * the "From" address because its data may come from a number of different
 373  * fields.  But we can use it for "To" and possibly others.
 374  */
 375 void imap_output_envelope_addr(char *addr) {
 376         char individual_addr[256];
 377         int num_addrs;
 378         int i;
 379         char user[256];
 380         char node[256];
 381         char name[256];
 382
 383         if (addr == NULL) {
 384                 cprintf("NIL ");
 385                 return;
 386         }
 387
 388         if (IsEmptyStr(addr)) {
 389                 cprintf("NIL ");
 390                 return;
 391         }
 392
 393         cprintf("(");
 394
 395         /* How many addresses are listed here? */
 396         num_addrs = num_tokens(addr, ',');
 397
 398         /* Output them one by one. */
 399         for (i=0; i<num_addrs; ++i) {
 400                 extract_token(individual_addr, addr, i, ',', sizeof individual_addr);
 401                 striplt(individual_addr);
 402                 process_rfc822_addr(individual_addr, user, node, name);
 403                 cprintf("(");
 404                 plain_imap_strout(name);
 405                 cprintf(" NIL ");
 406                 plain_imap_strout(user);
 407                 cprintf(" ");
 408                 plain_imap_strout(node);
 409                 cprintf(")");
 410                 if (i < (num_addrs-1)) cprintf(" ");
 411         }
 412
 413         cprintf(") ");
 414 }
 415
 416
 417 /*
 418  * Implements the ENVELOPE fetch item
 419  *
 420  * Note that the imap_strout() function can cleverly output NULL fields as NIL,
 421  * so we don't have to check for that condition like we do elsewhere.
 422  */
 423 void imap_fetch_envelope(struct CtdlMessage *msg) {
 424         char datestringbuf[SIZ];
 425         time_t msgdate;
 426         char *fieldptr = NULL;
 427
 428         if (!msg) return;
 429
 430         /* Parse the message date into an IMAP-format date string */
 431         if (msg->cm_fields['T'] != NULL) {
 432                 msgdate = atol(msg->cm_fields['T']);
 433         }
 434         else {
 435                 msgdate = time(NULL);
 436         }
 437         datestring(datestringbuf, sizeof datestringbuf,
 438                 msgdate, DATESTRING_IMAP);
 439
 440         /* Now start spewing data fields.  The order is important, as it is
 441          * defined by the protocol specification.  Nonexistent fields must
 442          * be output as NIL, existent fields must be quoted or literalled.
 443          * The imap_strout() function conveniently does all this for us.
 444          */
 445         cprintf("ENVELOPE (");
 446
 447         /* Date */
 448         plain_imap_strout(datestringbuf);
 449         cprintf(" ");
 450
 451         /* Subject */
 452         plain_imap_strout(msg->cm_fields['U']);
 453         cprintf(" ");
 454
 455         /* From */
 456         imap_output_envelope_from(msg);
 457
 458         /* Sender (default to same as 'From' if not present) */
 459         fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Sender");
 460         if (fieldptr != NULL) {
 461                 imap_output_envelope_addr(fieldptr);
 462                 free(fieldptr);
 463         }
 464         else {
 465                 imap_output_envelope_from(msg);
 466         }
 467
 468         /* Reply-to */
 469         fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Reply-to");
 470         if (fieldptr != NULL) {
 471                 imap_output_envelope_addr(fieldptr);
 472                 free(fieldptr);
 473         }
 474         else {
 475                 imap_output_envelope_from(msg);
 476         }
 477
 478         /* To */
 479         imap_output_envelope_addr(msg->cm_fields['R']);
 480
 481         /* Cc (we do it this way because there might be a legacy non-Citadel Cc: field present) */
 482         fieldptr = msg->cm_fields['Y'];
 483         if (fieldptr != NULL) {
 484                 imap_output_envelope_addr(fieldptr);
 485         }
 486         else {
 487                 fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Cc");
 488                 imap_output_envelope_addr(fieldptr);
 489                 if (fieldptr != NULL) free(fieldptr);
 490         }
 491
 492         /* Bcc */
 493         fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "Bcc");
 494         imap_output_envelope_addr(fieldptr);
 495         if (fieldptr != NULL) free(fieldptr);
 496
 497         /* In-reply-to */
 498         fieldptr = rfc822_fetch_field(msg->cm_fields['M'], "In-reply-to");
 499         plain_imap_strout(fieldptr);
 500         cprintf(" ");
 501         if (fieldptr != NULL) free(fieldptr);
 502
 503         /* message ID */
 504         plain_imap_strout(msg->cm_fields['I']);
 505
 506         cprintf(")");
 507 }
 508
 509 /*
 510  * This function is called only when CC->redirect_buffer contains a set of
 511  * RFC822 headers with no body attached.  Its job is to strip that set of
 512  * headers down to *only* the ones we're interested in.
 513  */
 514 void imap_strip_headers(StrBuf *section) {
 515         citimap_command Cmd;
 516         StrBuf *which_fields = NULL;
 517         int doing_headers = 0;
 518         int headers_not = 0;
 519         int num_parms = 0;
 520         int i;
 521         StrBuf *boiled_headers = NULL;
 522         StrBuf *Line;
 523         int ok = 0;
 524         int done_headers = 0;
 525         const char *Ptr = NULL;
 526         CitContext *CCC = CC;
 527
 528         if (CCC->redirect_buffer == NULL) return;
 529
 530         which_fields = NewStrBufDup(section);
 531
 532         if (!strncasecmp(ChrPtr(which_fields), "HEADER.FIELDS", 13))
 533                 doing_headers = 1;
 534         if (doing_headers &&
 535             !strncasecmp(ChrPtr(which_fields), "HEADER.FIELDS.NOT", 17))
 536                 headers_not = 1;
 537
 538         for (i=0; i < StrLength(which_fields); ++i) {
 539                 if (ChrPtr(which_fields)[i]=='(')
 540                         StrBufReplaceToken(which_fields, i, 1, HKEY(""));
 541         }
 542         for (i=0; i < StrLength(which_fields); ++i) {
 543                 if (ChrPtr(which_fields)[i]==')') {
 544                         StrBufCutAt(which_fields, i, NULL);
 545                         break;
 546                 }
 547         }
 548         memset(&Cmd, 0, sizeof(citimap_command));
 549         Cmd.CmdBuf = which_fields;
 550         num_parms = imap_parameterize(&Cmd);
 551
 552         boiled_headers = NewStrBufPlain(NULL, StrLength(CCC->redirect_buffer));
 553         Line = NewStrBufPlain(NULL, SIZ);
 554         Ptr = NULL;
 555         ok = 0;
 556         do {
 557                 StrBufSipLine(Line, CCC->redirect_buffer, &Ptr);
 558
 559                 if (!isspace(ChrPtr(Line)[0])) {
 560                         ok = 0;
 561                         if (doing_headers == 0) ok = 1;
 562                         else {
 563                                 /* we're supposed to print all headers that are not matching the filter list */
 564                                 if (headers_not) for (i=0, ok = 1; (i < num_parms) && (ok == 1); ++i) {
 565                                                 if ( (!strncasecmp(ChrPtr(Line),
 566                                                                    Cmd.Params[i].Key,
 567                                                                    Cmd.Params[i].len)) &&
 568                                                      (ChrPtr(Line)[Cmd.Params[i].len]==':') ) {
 569                                                         ok = 0;
 570                                                 }
 571                                 }
 572                                 /* we're supposed to print all headers matching the filterlist */
 573                                 else for (i=0, ok = 0; ((i < num_parms) && (ok == 0)); ++i) {
 574                                                 if ( (!strncasecmp(ChrPtr(Line),
 575                                                                    Cmd.Params[i].Key,
 576                                                                    Cmd.Params[i].len)) &&
 577                                                      (ChrPtr(Line)[Cmd.Params[i].len]==':') ) {
 578                                                         ok = 1;
 579                                         }
 580                                 }
 581                         }
 582                 }
 583
 584                 if (ok) {
 585                         StrBufAppendBuf(boiled_headers, Line, 0);
 586                         StrBufAppendBufPlain(boiled_headers, HKEY("\r\n"), 0);
 587                 }
 588
 589                 if ((Ptr == StrBufNOTNULL)  ||
 590                     (StrLength(Line) == 0)  ||
 591                     (ChrPtr(Line)[0]=='\r') ||
 592                     (ChrPtr(Line)[0]=='\n')   ) done_headers = 1;
 593         } while (!done_headers);
 594
 595         StrBufAppendBufPlain(boiled_headers, HKEY("\r\n"), 0);
 596
 597         /* Now save it back (it'll always be smaller) */
 598         FreeStrBuf(&CCC->redirect_buffer);
 599         CCC->redirect_buffer = boiled_headers;
 600
 601         free(Cmd.Params);
 602         FreeStrBuf(&which_fields);
 603         FreeStrBuf(&Line);
 604 }
 605
 606
 607 /*
 608  * Implements the BODY and BODY.PEEK fetch items
 609  */
 610 void imap_fetch_body(long msgnum, ConstStr item, int is_peek) {
 611         struct CtdlMessage *msg = NULL;
 612         StrBuf *section;
 613         StrBuf *partial;
 614         int is_partial = 0;
 615         size_t pstart, pbytes;
 616         int loading_body_now = 0;
 617         int need_body = 1;
 618         int burn_the_cache = 0;
 619         CitContext *CCC = CC;
 620
 621         /* extract section */
 622         section = NewStrBufPlain(CKEY(item));
 623
 624         if (strchr(ChrPtr(section), '[') != NULL) {
 625                 StrBufStripAllBut(section, '[', ']');
 626         }
 627         CtdlLogPrintf(CTDL_DEBUG, "Section is: [%s]\n",
 628               (StrLength(section) == 0) ? "(empty)" : ChrPtr(section)
 629         );
 630
 631         /* Burn the cache if we don't have the same section of the
 632          * same message again.
 633          */
 634         if (IMAP->cached_body != NULL) {
 635                 if (IMAP->cached_bodymsgnum != msgnum) {
 636                         burn_the_cache = 1;
 637                 }
 638                 else if ( (!IMAP->cached_body_withbody) && (need_body) ) {
 639                         burn_the_cache = 1;
 640                 }
 641                 else if (strcasecmp(IMAP->cached_bodypart, ChrPtr(section))) {
 642                         burn_the_cache = 1;
 643                 }
 644                 if (burn_the_cache) {
 645                         /* Yup, go ahead and burn the cache. */
 646                         free(IMAP->cached_body);
 647                         IMAP->cached_body_len = 0;
 648                         IMAP->cached_body = NULL;
 649                         IMAP->cached_bodymsgnum = (-1);
 650                         strcpy(IMAP->cached_bodypart, "");
 651                 }
 652         }
 653
 654         /* extract partial */
 655         partial = NewStrBufPlain(CKEY(item));
 656         if (strchr(ChrPtr(partial), '<') != NULL) {
 657                 StrBufStripAllBut(partial, '<', '>');
 658                 is_partial = 1;
 659         }
 660         if ( (is_partial == 1) && (StrLength(partial) > 0) ) {
 661                 CtdlLogPrintf(CTDL_DEBUG, "Partial is <%s>\n", ChrPtr(partial));
 662         }
 663
 664         if (IMAP->cached_body == NULL) {
 665                 CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
 666                 loading_body_now = 1;
 667                 msg = CtdlFetchMessage(msgnum, (need_body ? 1 : 0));
 668         }
 669
 670         /* Now figure out what the client wants, and get it */
 671
 672         if (!loading_body_now) {
 673                 /* What we want is already in memory */
 674         }
 675
 676         else if ( (!strcmp(ChrPtr(section), "1")) && (msg->cm_format_type != 4) ) {
 677                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
 678         }
 679
 680         else if (StrLength(section) == 0) {
 681                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, SUPPRESS_ENV_TO);
 682         }
 683
 684         /*
 685          * If the client asked for just headers, or just particular header
 686          * fields, strip it down.
 687          */
 688         else if (!strncasecmp(ChrPtr(section), "HEADER", 6)) {
 689                 /* This used to work with HEADERS_FAST, but then Apple got stupid with their
 690                  * IMAP library and this broke Mail.App and iPhone Mail, so we had to change it
 691                  * to HEADERS_ONLY so the trendy hipsters with their iPhones can read mail.
 692                  */
 693                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, SUPPRESS_ENV_TO);
 694                 imap_strip_headers(section);
 695         }
 696
 697         /*
 698          * Strip it down if the client asked for everything _except_ headers.
 699          */
 700         else if (!strncasecmp(ChrPtr(section), "TEXT", 4)) {
 701                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_NONE, 0, 1, SUPPRESS_ENV_TO);
 702         }
 703
 704         /*
 705          * Anything else must be a part specifier.
 706          * (Note value of 1 passed as 'dont_decode' so client gets it encoded)
 707          */
 708         else {
 709                 mime_parser(msg->cm_fields['M'], NULL,
 710                                 *imap_load_part, NULL, NULL,
 711                                 ChrPtr(section),
 712                                 1
 713                 );
 714         }
 715
 716         if (loading_body_now) {
 717                 IMAP->cached_body_len = StrLength(CCC->redirect_buffer);
 718                 IMAP->cached_body = SmashStrBuf(&CCC->redirect_buffer);
 719                 IMAP->cached_bodymsgnum = msgnum;
 720                 IMAP->cached_body_withbody = need_body;
 721                 strcpy(IMAP->cached_bodypart, ChrPtr(section));
 722         }
 723
 724         if (is_partial == 0) {
 725                 cprintf("BODY[%s] {" SIZE_T_FMT "}\r\n", ChrPtr(section), IMAP->cached_body_len);
 726                 pstart = 0;
 727                 pbytes = IMAP->cached_body_len;
 728         }
 729         else {
 730                 sscanf(ChrPtr(partial), SIZE_T_FMT "." SIZE_T_FMT, &pstart, &pbytes);
 731                 if (pbytes > (IMAP->cached_body_len - pstart)) {
 732                         pbytes = IMAP->cached_body_len - pstart;
 733                 }
 734                 cprintf("BODY[%s]<" SIZE_T_FMT "> {" SIZE_T_FMT "}\r\n", ChrPtr(section), pstart, pbytes);
 735         }
 736
 737         FreeStrBuf(&partial);
 738
 739         /* Here we go -- output it */
 740         client_write(&IMAP->cached_body[pstart], pbytes);
 741
 742         if (msg != NULL) {
 743                 CtdlFreeMessage(msg);
 744         }
 745
 746         /* Mark this message as "seen" *unless* this is a "peek" operation */
 747         if (is_peek == 0) {
 748                 CtdlSetSeen(&msgnum, 1, 1, ctdlsetseen_seen, NULL, NULL);
 749         }
 750         FreeStrBuf(&section);
 751 }
 752
 753 /*
 754  * Called immediately before outputting a multipart bodystructure
 755  */
 756 void imap_fetch_bodystructure_pre(
 757                 char *name, char *filename, char *partnum, char *disp,
 758                 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
 759                 char *cbid, void *cbuserdata
 760                 ) {
 761
 762         cprintf("(");
 763 }
 764
 765
 766
 767 /*
 768  * Called immediately after outputting a multipart bodystructure
 769  */
 770 void imap_fetch_bodystructure_post(
 771                 char *name, char *filename, char *partnum, char *disp,
 772                 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
 773                 char *cbid, void *cbuserdata
 774                 ) {
 775
 776         char subtype[128];
 777
 778         cprintf(" ");
 779
 780         /* disposition */
 781         extract_token(subtype, cbtype, 1, '/', sizeof subtype);
 782         plain_imap_strout(subtype);
 783
 784         /* body language */
 785         /* cprintf(" NIL"); We thought we needed this at one point, but maybe we don't... */
 786
 787         cprintf(")");
 788 }
 789
 790
 791
 792 /*
 793  * Output the info for a MIME part in the format required by BODYSTRUCTURE.
 794  *
 795  */
 796 void imap_fetch_bodystructure_part(
 797                 char *name, char *filename, char *partnum, char *disp,
 798                 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
 799                 char *cbid, void *cbuserdata
 800                 ) {
 801
 802         int have_cbtype = 0;
 803         int have_encoding = 0;
 804         int lines = 0;
 805         size_t i;
 806         char cbmaintype[128];
 807         char cbsubtype[128];
 808
 809         if (cbtype != NULL) if (!IsEmptyStr(cbtype)) have_cbtype = 1;
 810         if (have_cbtype) {
 811                 extract_token(cbmaintype, cbtype, 0, '/', sizeof cbmaintype);
 812                 extract_token(cbsubtype, cbtype, 1, '/', sizeof cbsubtype);
 813         }
 814         else {
 815                 strcpy(cbmaintype, "TEXT");
 816                 strcpy(cbsubtype, "PLAIN");
 817         }
 818
 819         cprintf("(");
 820         plain_imap_strout(cbmaintype);                                  /* body type */
 821         cprintf(" ");
 822         plain_imap_strout(cbsubtype);                                           /* body subtype */
 823         cprintf(" ");
 824
 825         cprintf("(");                                                   /* begin body parameter list */
 826
 827         /* "NAME" must appear as the first parameter.  This is not required by IMAP,
 828          * but the Asterisk voicemail application blindly assumes that NAME will be in
 829          * the first position.  If it isn't, it rejects the message.
 830          */
 831         if (name != NULL) if (!IsEmptyStr(name)) {
 832                 cprintf("\"NAME\" ");
 833                 plain_imap_strout(name);
 834                 cprintf(" ");
 835         }
 836
 837         cprintf("\"CHARSET\" ");
 838         if (cbcharset == NULL) {
 839                 plain_imap_strout("US-ASCII");
 840         }
 841         else if (cbcharset[0] == 0) {
 842                 plain_imap_strout("US-ASCII");
 843         }
 844         else {
 845                 plain_imap_strout(cbcharset);
 846         }
 847         cprintf(") ");                                                  /* end body parameter list */
 848
 849         cprintf("NIL ");                                                /* Body ID */
 850         cprintf("NIL ");                                                /* Body description */
 851
 852         if (encoding != NULL) if (encoding[0] != 0)  have_encoding = 1;
 853         if (have_encoding) {
 854                 plain_imap_strout(encoding);
 855         }
 856         else {
 857                 plain_imap_strout("7BIT");
 858         }
 859         cprintf(" ");
 860
 861         /* The next field is the size of the part in bytes. */
 862         cprintf("%ld ", (long)length);  /* bytes */
 863
 864         /* The next field is the number of lines in the part, if and only
 865          * if the part is TEXT.  More gratuitous complexity.
 866          */
 867         if (!strcasecmp(cbmaintype, "TEXT")) {
 868                 if (length) for (i=0; i<length; ++i) {
 869                         if (((char *)content)[i] == '\n') ++lines;
 870                 }
 871                 cprintf("%d ", lines);
 872         }
 873
 874         /* More gratuitous complexity */
 875         if ((!strcasecmp(cbmaintype, "MESSAGE"))
 876            && (!strcasecmp(cbsubtype, "RFC822"))) {
 877                 /* FIXME: message/rfc822 also needs to output the envelope structure,
 878                  * body structure, and line count of the encapsulated message.  Fortunately
 879                  * there are not yet any clients depending on this, so we can get away
 880                  * with not implementing it for now.
 881                  */
 882         }
 883
 884         /* MD5 value of body part; we can get away with NIL'ing this */
 885         cprintf("NIL ");
 886
 887         /* Disposition */
 888         if (disp == NULL) {
 889                 cprintf("NIL");
 890         }
 891         else if (IsEmptyStr(disp)) {
 892                 cprintf("NIL");
 893         }
 894         else {
 895                 cprintf("(");
 896                 plain_imap_strout(disp);
 897                 if (filename != NULL) if (!IsEmptyStr(filename)) {
 898                         cprintf(" (\"FILENAME\" ");
 899                         plain_imap_strout(filename);
 900                         cprintf(")");
 901                 }
 902                 cprintf(")");
 903         }
 904
 905         /* Body language (not defined yet) */
 906         cprintf(" NIL)");
 907 }
 908
 909
 910
 911 /*
 912  * Spew the BODYSTRUCTURE data for a message.
 913  *
 914  */
 915 void imap_fetch_bodystructure (long msgnum, const char *item,
 916                 struct CtdlMessage *msg) {
 917         const char *rfc822 = NULL;
 918         const char *rfc822_body = NULL;
 919         size_t rfc822_len;
 920         size_t rfc822_headers_len;
 921         size_t rfc822_body_len;
 922         const char *ptr = NULL;
 923         char *pch;
 924         char buf[SIZ];
 925         int lines = 0;
 926
 927         /* Handle NULL message gracefully */
 928         if (msg == NULL) {
 929                 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
 930                         "(\"CHARSET\" \"US-ASCII\") NIL NIL "
 931                         "\"7BIT\" 0 0)");
 932                 return;
 933         }
 934
 935         /* For non-RFC822 (ordinary Citadel) messages, this is short and
 936          * sweet...
 937          */
 938         if (msg->cm_format_type != FMT_RFC822) {
 939
 940                 /* *sigh* We have to RFC822-format the message just to be able
 941                  * to measure it.  FIXME use smi cached fields if possible
 942                  */
 943
 944                 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
 945                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, 0, 0, 1, SUPPRESS_ENV_TO);
 946                 rfc822_len = StrLength(CC->redirect_buffer);
 947                 rfc822 = pch = SmashStrBuf(&CC->redirect_buffer);
 948
 949                 ptr = rfc822;
 950                 do {
 951                         ptr = cmemreadline(ptr, buf, sizeof buf);
 952                         ++lines;
 953                         if ((IsEmptyStr(buf)) && (rfc822_body == NULL)) {
 954                                 rfc822_body = ptr;
 955                         }
 956                 } while (*ptr != 0);
 957
 958                 rfc822_headers_len = rfc822_body - rfc822;
 959                 rfc822_body_len = rfc822_len - rfc822_headers_len;
 960                 free(pch);
 961
 962                 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
 963                         "(\"CHARSET\" \"US-ASCII\") NIL NIL "
 964                         "\"7BIT\" " SIZE_T_FMT " %d)", rfc822_body_len, lines);
 965
 966                 return;
 967         }
 968
 969         /* For messages already stored in RFC822 format, we have to parse. */
 970         cprintf("BODYSTRUCTURE ");
 971         mime_parser(msg->cm_fields['M'],
 972                         NULL,
 973                         *imap_fetch_bodystructure_part, /* part */
 974                         *imap_fetch_bodystructure_pre,  /* pre-multi */
 975                         *imap_fetch_bodystructure_post, /* post-multi */
 976                         NULL,
 977                         1);     /* don't decode -- we want it as-is */
 978 }
 979
 980
 981 /*
 982  * imap_do_fetch() calls imap_do_fetch_msg() to output the data of an
 983  * individual message, once it has been selected for output.
 984  */
 985 void imap_do_fetch_msg(int seq, citimap_command *Cmd) {
 986         int i;
 987         citimap *Imap = IMAP;
 988         struct CtdlMessage *msg = NULL;
 989         int body_loaded = 0;
 990
 991         /* Don't attempt to fetch bogus messages or UID's */
 992         if (seq < 1) return;
 993         if (Imap->msgids[seq-1] < 1L) return;
 994
 995         buffer_output();
 996         cprintf("* %d FETCH (", seq);
 997
 998         for (i=0; i<Cmd->num_parms; ++i) {
 999
1000                 /* Fetchable without going to the message store at all */
1001                 if (!strcasecmp(Cmd->Params[i].Key, "UID")) {
1002                         imap_fetch_uid(seq);
1003                 }
1004                 else if (!strcasecmp(Cmd->Params[i].Key, "FLAGS")) {
1005                         imap_fetch_flags(seq-1);
1006                 }
1007
1008                 /* Potentially fetchable from cache, if the client requests
1009                  * stuff from the same message several times in a row.
1010                  */
1011                 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822")) {
1012                         imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1013                 }
1014                 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.HEADER")) {
1015                         imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1016                 }
1017                 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.SIZE")) {
1018                         imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1019                 }
1020                 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.TEXT")) {
1021                         imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1022                 }
1023
1024                 /* BODY fetches do their own fetching and caching too. */
1025                 else if (!strncasecmp(Cmd->Params[i].Key, "BODY[", 5)) {
1026                         imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i], 0);
1027                 }
1028                 else if (!strncasecmp(Cmd->Params[i].Key, "BODY.PEEK[", 10)) {
1029                         imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i], 1);
1030                 }
1031
1032                 /* Otherwise, load the message into memory.
1033                  */
1034                 else if (!strcasecmp(Cmd->Params[i].Key, "BODYSTRUCTURE")) {
1035                         if ((msg != NULL) && (!body_loaded)) {
1036                                 CtdlFreeMessage(msg);   /* need the whole thing */
1037                                 msg = NULL;
1038                         }
1039                         if (msg == NULL) {
1040                                 msg = CtdlFetchMessage(Imap->msgids[seq-1], 1);
1041                                 body_loaded = 1;
1042                         }
1043                         imap_fetch_bodystructure(Imap->msgids[seq-1],
1044                                         Cmd->Params[i].Key, msg);
1045                 }
1046                 else if (!strcasecmp(Cmd->Params[i].Key, "ENVELOPE")) {
1047                         if (msg == NULL) {
1048                                 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0);
1049                                 body_loaded = 0;
1050                         }
1051                         imap_fetch_envelope(msg);
1052                 }
1053                 else if (!strcasecmp(Cmd->Params[i].Key, "INTERNALDATE")) {
1054                         if (msg == NULL) {
1055                                 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0);
1056                                 body_loaded = 0;
1057                         }
1058                         imap_fetch_internaldate(msg);
1059                 }
1060
1061                 if (i != Cmd->num_parms-1) cprintf(" ");
1062         }
1063
1064         cprintf(")\r\n");
1065         unbuffer_output();
1066         if (msg != NULL) {
1067                 CtdlFreeMessage(msg);
1068         }
1069 }
1070
1071
1072
1073 /*
1074  * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
1075  * validated and boiled down the request a bit.
1076  */
1077 void imap_do_fetch(citimap_command *Cmd) {
1078         int i;
1079 #if 0
1080 /* debug output the parsed vector */
1081         {
1082                 int i;
1083                 CtdlLogPrintf(CTDL_DEBUG, "----- %ld params \n",
1084                               Cmd->num_parms);
1085
1086         for (i=0; i < Cmd->num_parms; i++) {
1087                 if (Cmd->Params[i].len != strlen(Cmd->Params[i].Key))
1088                         CtdlLogPrintf(CTDL_DEBUG, "*********** %ld != %ld : %s\n",
1089                                       Cmd->Params[i].len,
1090                                       strlen(Cmd->Params[i].Key),
1091                                       Cmd->Params[i].Key);
1092                 else
1093                         CtdlLogPrintf(CTDL_DEBUG, "%ld : %s\n",
1094                                       Cmd->Params[i].len,
1095                                       Cmd->Params[i].Key);
1096         }}
1097
1098 #endif
1099
1100         if (IMAP->num_msgs > 0) {
1101                 for (i = 0; i < IMAP->num_msgs; ++i) {
1102
1103                         /* Abort the fetch loop if the session breaks.
1104                          * This is important for users who keep mailboxes
1105                          * that are too big *and* are too impatient to
1106                          * let them finish loading.  :)
1107                          */
1108                         if (CC->kill_me) return;
1109
1110                         /* Get any message marked for fetch. */
1111                         if (IMAP->flags[i] & IMAP_SELECTED) {
1112                                 imap_do_fetch_msg(i+1, Cmd);
1113                         }
1114                 }
1115         }
1116 }
1117
1118
1119
1120 /*
1121  * Back end for imap_handle_macros()
1122  * Note that this function *only* looks at the beginning of the string.  It
1123  * is not a generic search-and-replace function.
1124  */
1125 void imap_macro_replace(StrBuf *Buf, long where,
1126                         StrBuf *TmpBuf,
1127                         char *find, long findlen,
1128                         char *replace, long replacelen)
1129 {
1130
1131         if (StrLength(Buf) - where > findlen)
1132                 return;
1133
1134         if (!strncasecmp(ChrPtr(Buf) + where, find, findlen)) {
1135                 if (ChrPtr(Buf)[where + findlen] == ' ') {
1136                         StrBufPlain(TmpBuf, replace, replacelen);
1137                         StrBufAppendBufPlain(TmpBuf, HKEY(" "), 0);
1138                         StrBufReplaceToken(Buf, where, findlen,
1139                                            SKEY(TmpBuf));
1140                 }
1141                 if (where + findlen == StrLength(Buf)) {
1142                         StrBufReplaceToken(Buf, where, findlen,
1143                                            replace, replacelen);
1144                 }
1145         }
1146 }
1147
1148
1149
1150 /*
1151  * Handle macros embedded in FETCH data items.
1152  * (What the heck are macros doing in a wire protocol?  Are we trying to save
1153  * the computer at the other end the trouble of typing a lot of characters?)
1154  */
1155 void imap_handle_macros(citimap_command *Cmd) {
1156         long i;
1157         int nest = 0;
1158         StrBuf *Tmp = NewStrBuf();
1159
1160         for (i=0; i < StrLength(Cmd->CmdBuf); ++i) {
1161                 char ch = ChrPtr(Cmd->CmdBuf)[i];
1162                 if ((ch=='(') ||
1163                     (ch=='[') ||
1164                     (ch=='<') ||
1165                     (ch=='{')) ++nest;
1166                 else if ((ch==')') ||
1167                          (ch==']') ||
1168                          (ch=='>') ||
1169                          (ch=='}')) --nest;
1170
1171                 if (nest <= 0) {
1172                         imap_macro_replace(Cmd->CmdBuf, i,
1173                                            Tmp,
1174                                            HKEY("ALL"),
1175                                            HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE")
1176                         );
1177                         imap_macro_replace(Cmd->CmdBuf, i,
1178                                            Tmp,
1179                                            HKEY("BODY"),
1180                                            HKEY("BODYSTRUCTURE")
1181                         );
1182                         imap_macro_replace(Cmd->CmdBuf, i,
1183                                            Tmp,
1184                                            HKEY("FAST"),
1185                                            HKEY("FLAGS INTERNALDATE RFC822.SIZE")
1186                         );
1187                         imap_macro_replace(Cmd->CmdBuf, i,
1188                                            Tmp,
1189                                            HKEY("FULL"),
1190                                            HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY")
1191                         );
1192                 }
1193         }
1194         FreeStrBuf(&Tmp);
1195 }
1196
1197
1198 /*
1199  * Break out the data items requested, possibly a parenthesized list.
1200  * Returns the number of data items, or -1 if the list is invalid.
1201  * NOTE: this function alters the string it is fed, and uses it as a buffer
1202  * to hold the data for the pointers it returns.
1203  */
1204 int imap_extract_data_items(citimap_command *Cmd)
1205 {
1206         int nArgs;
1207         int nest = 0;
1208         const char *pch, *end;
1209         long initial_len;
1210
1211         /* Convert all whitespace to ordinary space characters. */
1212         pch = ChrPtr(Cmd->CmdBuf);
1213         end = pch + StrLength(Cmd->CmdBuf);
1214
1215         while (pch < end)
1216         {
1217                 if (isspace(*pch))
1218                         StrBufPeek(Cmd->CmdBuf, pch, 0, ' ');
1219                 pch++;
1220         }
1221
1222         /* Strip leading and trailing whitespace, then strip leading and
1223          * trailing parentheses if it's a list
1224          */
1225         StrBufTrim(Cmd->CmdBuf);
1226         pch = ChrPtr(Cmd->CmdBuf);
1227         if ( (pch[0]=='(') &&
1228              (pch[StrLength(Cmd->CmdBuf)-1]==')') )
1229         {
1230                 StrBufCutRight(Cmd->CmdBuf, 1);
1231                 StrBufCutLeft(Cmd->CmdBuf, 1);
1232                 StrBufTrim(Cmd->CmdBuf);
1233         }
1234
1235         /* Parse any macro data items */
1236         imap_handle_macros(Cmd);
1237
1238         /*
1239          * Now break out the data items.  We throw in one trailing space in
1240          * order to avoid having to break out the last one manually.
1241          */
1242         nArgs = StrLength(Cmd->CmdBuf) / 10 + 10;
1243         nArgs = CmdAdjust(Cmd, nArgs, 0);
1244         initial_len = StrLength(Cmd->CmdBuf);
1245         Cmd->num_parms = 0;
1246         Cmd->Params[Cmd->num_parms].Key = pch = ChrPtr(Cmd->CmdBuf);
1247         end = Cmd->Params[Cmd->num_parms].Key + StrLength(Cmd->CmdBuf);
1248
1249         while (pch < end)
1250         {
1251                 if ((*pch=='(') ||
1252                     (*pch=='[') ||
1253                     (*pch=='<') ||
1254                     (*pch=='{'))
1255                         ++nest;
1256
1257                 else if ((*pch==')') ||
1258                          (*pch==']') ||
1259                          (*pch=='>') ||
1260                          (*pch=='}'))
1261                         --nest;
1262
1263                 if ((nest <= 0) && (*pch==' ')) {
1264                         StrBufPeek(Cmd->CmdBuf, pch, 0, '\0');
1265                         Cmd->Params[Cmd->num_parms].len =
1266                                 pch - Cmd->Params[Cmd->num_parms].Key;
1267
1268                         if (Cmd->num_parms + 1 >= Cmd->avail_parms) {
1269                                 nArgs = CmdAdjust(Cmd, nArgs * 2, 1);
1270                         }
1271                         Cmd->num_parms++;
1272                         Cmd->Params[Cmd->num_parms].Key = ++pch;
1273                 }
1274                 else if (pch + 1 == end) {
1275                         Cmd->Params[Cmd->num_parms].len =
1276                                 pch - Cmd->Params[Cmd->num_parms].Key + 1;
1277
1278                         Cmd->num_parms++;
1279                 }
1280                 pch ++;
1281         }
1282         return Cmd->num_parms;
1283
1284 }
1285
1286
1287 /*
1288  * One particularly hideous aspect of IMAP is that we have to allow the client
1289  * to specify arbitrary ranges and/or sets of messages to fetch.  Citadel IMAP
1290  * handles this by setting the IMAP_SELECTED flag for each message specified in
1291  * the ranges/sets, then looping through the message array, outputting messages
1292  * with the flag set.  We don't bother returning an error if an out-of-range
1293  * number is specified (we just return quietly) because any client braindead
1294  * enough to request a bogus message number isn't going to notice the
1295  * difference anyway.
1296  *
1297  * This function clears out the IMAP_SELECTED bits, then sets that bit for each
1298  * message included in the specified range.
1299  *
1300  * Set is_uid to 1 to fetch by UID instead of sequence number.
1301  */
1302 void imap_pick_range(const char *supplied_range, int is_uid) {
1303         int i;
1304         int num_sets;
1305         int s;
1306         char setstr[SIZ], lostr[SIZ], histr[SIZ];
1307         long lo, hi;
1308         char actual_range[SIZ];
1309         citimap *Imap;
1310
1311         /*
1312          * Handle the "ALL" macro
1313          */
1314         if (!strcasecmp(supplied_range, "ALL")) {
1315                 safestrncpy(actual_range, "1:*", sizeof actual_range);
1316         }
1317         else {
1318                 safestrncpy(actual_range, supplied_range, sizeof actual_range);
1319         }
1320
1321         Imap = IMAP;
1322         /*
1323          * Clear out the IMAP_SELECTED flags for all messages.
1324          */
1325         for (i = 0; i < Imap->num_msgs; ++i) {
1326                 Imap->flags[i] = Imap->flags[i] & ~IMAP_SELECTED;
1327         }
1328
1329         /*
1330          * Now set it for all specified messages.
1331          */
1332         num_sets = num_tokens(actual_range, ',');
1333         for (s=0; s<num_sets; ++s) {
1334                 extract_token(setstr, actual_range, s, ',', sizeof setstr);
1335
1336                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
1337                 if (num_tokens(setstr, ':') >= 2) {
1338                         extract_token(histr, setstr, 1, ':', sizeof histr);
1339                         if (!strcmp(histr, "*")) snprintf(histr, sizeof histr, "%ld", LONG_MAX);
1340                 }
1341                 else {
1342                         safestrncpy(histr, lostr, sizeof histr);
1343                 }
1344                 lo = atol(lostr);
1345                 hi = atol(histr);
1346
1347                 /* Loop through the array, flipping bits where appropriate */
1348                 for (i = 1; i <= Imap->num_msgs; ++i) {
1349                         if (is_uid) {   /* fetch by sequence number */
1350                                 if ( (Imap->msgids[i-1]>=lo)
1351                                    && (Imap->msgids[i-1]<=hi)) {
1352                                         Imap->flags[i-1] |= IMAP_SELECTED;
1353                                 }
1354                         }
1355                         else {          /* fetch by uid */
1356                                 if ( (i>=lo) && (i<=hi)) {
1357                                         Imap->flags[i-1] |= IMAP_SELECTED;
1358                                 }
1359                         }
1360                 }
1361         }
1362 }
1363
1364
1365
1366 /*
1367  * This function is called by the main command loop.
1368  */
1369 void imap_fetch(int num_parms, ConstStr *Params) {
1370         citimap_command Cmd;
1371         int num_items;
1372
1373         if (num_parms < 4) {
1374                 cprintf("%s BAD invalid parameters\r\n", Params[0].Key);
1375                 return;
1376         }
1377
1378         imap_pick_range(Params[2].Key, 0);
1379
1380         memset(&Cmd, 0, sizeof(citimap_command));
1381         Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1382         MakeStringOf(Cmd.CmdBuf, 3);
1383
1384         num_items = imap_extract_data_items(&Cmd);
1385         if (num_items < 1) {
1386                 cprintf("%s BAD invalid data item list\r\n", Params[0].Key);
1387                 FreeStrBuf(&Cmd.CmdBuf);
1388                 free(Cmd.Params);
1389                 return;
1390         }
1391
1392         imap_do_fetch(&Cmd);
1393         cprintf("%s OK FETCH completed\r\n", Params[0].Key);
1394         FreeStrBuf(&Cmd.CmdBuf);
1395         free(Cmd.Params);
1396 }
1397
1398 /*
1399  * This function is called by the main command loop.
1400  */
1401 void imap_uidfetch(int num_parms, ConstStr *Params) {
1402         citimap_command Cmd;
1403         int num_items;
1404         int i;
1405         int have_uid_item = 0;
1406
1407         if (num_parms < 5) {
1408                 cprintf("%s BAD invalid parameters\r\n", Params[0].Key);
1409                 return;
1410         }
1411
1412         imap_pick_range(Params[3].Key, 1);
1413
1414         memset(&Cmd, 0, sizeof(citimap_command));
1415         Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1416
1417         MakeStringOf(Cmd.CmdBuf, 4);
1418 #if 0
1419         CtdlLogPrintf(CTDL_DEBUG, "-------%s--------\n", ChrPtr(Cmd.CmdBuf));
1420 #endif
1421         num_items = imap_extract_data_items(&Cmd);
1422         if (num_items < 1) {
1423                 cprintf("%s BAD invalid data item list\r\n", Params[0].Key);
1424                 FreeStrBuf(&Cmd.CmdBuf);
1425                 free(Cmd.Params);
1426                 return;
1427         }
1428
1429         /* If the "UID" item was not included, we include it implicitly
1430          * (at the beginning) because this is a UID FETCH command
1431          */
1432         for (i=0; i<num_items; ++i) {
1433                 if (!strcasecmp(Cmd.Params[i].Key, "UID")) ++have_uid_item;
1434         }
1435         if (have_uid_item == 0) {
1436                 if (Cmd.num_parms + 1 >= Cmd.avail_parms)
1437                         CmdAdjust(&Cmd, Cmd.avail_parms + 1, 1);
1438                 memmove(&Cmd.Params[1],
1439                         &Cmd.Params[0],
1440                         sizeof(ConstStr) * Cmd.num_parms);
1441
1442                 Cmd.num_parms++;
1443                 Cmd.Params[0] = (ConstStr){HKEY("UID")};
1444         }
1445
1446         imap_do_fetch(&Cmd);
1447         cprintf("%s OK UID FETCH completed\r\n", Params[0].Key);
1448         FreeStrBuf(&Cmd.CmdBuf);
1449         free(Cmd.Params);
1450 }
1451
1452