citadel/modules/imap/imap_fetch.c

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