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