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 == 0)
 657                 if (StrLength(partial) > 0)
 658                         CtdlLogPrintf(CTDL_DEBUG,
 659                                       "Partial is %s\n",
 660                                       ChrPtr(partial));
 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                                 section,
 710                                 1);
 711         }
 712
 713         if (loading_body_now) {
 714                 IMAP->cached_body_len = StrLength(CCC->redirect_buffer);
 715                 IMAP->cached_body = SmashStrBuf(&CCC->redirect_buffer);
 716                 IMAP->cached_bodymsgnum = msgnum;
 717                 IMAP->cached_body_withbody = need_body;
 718                 strcpy(IMAP->cached_bodypart, ChrPtr(section));
 719         }
 720
 721         if (is_partial == 0) {
 722                 cprintf("BODY[%s] {" SIZE_T_FMT "}\r\n", ChrPtr(section), IMAP->cached_body_len);
 723                 pstart = 0;
 724                 pbytes = IMAP->cached_body_len;
 725         }
 726         else {
 727                 sscanf(ChrPtr(partial), SIZE_T_FMT "." SIZE_T_FMT, &pstart, &pbytes);
 728                 if (pbytes > (IMAP->cached_body_len - pstart)) {
 729                         pbytes = IMAP->cached_body_len - pstart;
 730                 }
 731                 cprintf("BODY[%s]<" SIZE_T_FMT "> {" SIZE_T_FMT "}\r\n", ChrPtr(section), pstart, pbytes);
 732         }
 733
 734         FreeStrBuf(&partial);
 735
 736         /* Here we go -- output it */
 737         client_write(&IMAP->cached_body[pstart], pbytes);
 738
 739         if (msg != NULL) {
 740                 CtdlFreeMessage(msg);
 741         }
 742
 743         /* Mark this message as "seen" *unless* this is a "peek" operation */
 744         if (is_peek == 0) {
 745                 CtdlSetSeen(&msgnum, 1, 1, ctdlsetseen_seen, NULL, NULL);
 746         }
 747         FreeStrBuf(&section);
 748 }
 749
 750 /*
 751  * Called immediately before outputting a multipart bodystructure
 752  */
 753 void imap_fetch_bodystructure_pre(
 754                 char *name, char *filename, char *partnum, char *disp,
 755                 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
 756                 char *cbid, void *cbuserdata
 757                 ) {
 758
 759         cprintf("(");
 760 }
 761
 762
 763
 764 /*
 765  * Called immediately after outputting a multipart bodystructure
 766  */
 767 void imap_fetch_bodystructure_post(
 768                 char *name, char *filename, char *partnum, char *disp,
 769                 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
 770                 char *cbid, void *cbuserdata
 771                 ) {
 772
 773         char subtype[128];
 774
 775         cprintf(" ");
 776
 777         /* disposition */
 778         extract_token(subtype, cbtype, 1, '/', sizeof subtype);
 779         plain_imap_strout(subtype);
 780
 781         /* body language */
 782         /* cprintf(" NIL"); We thought we needed this at one point, but maybe we don't... */
 783
 784         cprintf(")");
 785 }
 786
 787
 788
 789 /*
 790  * Output the info for a MIME part in the format required by BODYSTRUCTURE.
 791  *
 792  */
 793 void imap_fetch_bodystructure_part(
 794                 char *name, char *filename, char *partnum, char *disp,
 795                 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
 796                 char *cbid, void *cbuserdata
 797                 ) {
 798
 799         int have_cbtype = 0;
 800         int have_encoding = 0;
 801         int lines = 0;
 802         size_t i;
 803         char cbmaintype[128];
 804         char cbsubtype[128];
 805
 806         if (cbtype != NULL) if (!IsEmptyStr(cbtype)) have_cbtype = 1;
 807         if (have_cbtype) {
 808                 extract_token(cbmaintype, cbtype, 0, '/', sizeof cbmaintype);
 809                 extract_token(cbsubtype, cbtype, 1, '/', sizeof cbsubtype);
 810         }
 811         else {
 812                 strcpy(cbmaintype, "TEXT");
 813                 strcpy(cbsubtype, "PLAIN");
 814         }
 815
 816         cprintf("(");
 817         plain_imap_strout(cbmaintype);                                  /* body type */
 818         cprintf(" ");
 819         plain_imap_strout(cbsubtype);                                           /* body subtype */
 820         cprintf(" ");
 821
 822         cprintf("(");                                                   /* begin body parameter list */
 823
 824         /* "NAME" must appear as the first parameter.  This is not required by IMAP,
 825          * but the Asterisk voicemail application blindly assumes that NAME will be in
 826          * the first position.  If it isn't, it rejects the message.
 827          */
 828         if (name != NULL) if (!IsEmptyStr(name)) {
 829                 cprintf("\"NAME\" ");
 830                 plain_imap_strout(name);
 831                 cprintf(" ");
 832         }
 833
 834         cprintf("\"CHARSET\" ");
 835         if (cbcharset == NULL) {
 836                 plain_imap_strout("US-ASCII");
 837         }
 838         else if (cbcharset[0] == 0) {
 839                 plain_imap_strout("US-ASCII");
 840         }
 841         else {
 842                 plain_imap_strout(cbcharset);
 843         }
 844         cprintf(") ");                                                  /* end body parameter list */
 845
 846         cprintf("NIL ");                                                /* Body ID */
 847         cprintf("NIL ");                                                /* Body description */
 848
 849         if (encoding != NULL) if (encoding[0] != 0)  have_encoding = 1;
 850         if (have_encoding) {
 851                 plain_imap_strout(encoding);
 852         }
 853         else {
 854                 plain_imap_strout("7BIT");
 855         }
 856         cprintf(" ");
 857
 858         /* The next field is the size of the part in bytes. */
 859         cprintf("%ld ", (long)length);  /* bytes */
 860
 861         /* The next field is the number of lines in the part, if and only
 862          * if the part is TEXT.  More gratuitous complexity.
 863          */
 864         if (!strcasecmp(cbmaintype, "TEXT")) {
 865                 if (length) for (i=0; i<length; ++i) {
 866                         if (((char *)content)[i] == '\n') ++lines;
 867                 }
 868                 cprintf("%d ", lines);
 869         }
 870
 871         /* More gratuitous complexity */
 872         if ((!strcasecmp(cbmaintype, "MESSAGE"))
 873            && (!strcasecmp(cbsubtype, "RFC822"))) {
 874                 /* FIXME: message/rfc822 also needs to output the envelope structure,
 875                  * body structure, and line count of the encapsulated message.  Fortunately
 876                  * there are not yet any clients depending on this, so we can get away
 877                  * with not implementing it for now.
 878                  */
 879         }
 880
 881         /* MD5 value of body part; we can get away with NIL'ing this */
 882         cprintf("NIL ");
 883
 884         /* Disposition */
 885         if (disp == NULL) {
 886                 cprintf("NIL");
 887         }
 888         else if (IsEmptyStr(disp)) {
 889                 cprintf("NIL");
 890         }
 891         else {
 892                 cprintf("(");
 893                 plain_imap_strout(disp);
 894                 if (filename != NULL) if (!IsEmptyStr(filename)) {
 895                         cprintf(" (\"FILENAME\" ");
 896                         plain_imap_strout(filename);
 897                         cprintf(")");
 898                 }
 899                 cprintf(")");
 900         }
 901
 902         /* Body language (not defined yet) */
 903         cprintf(" NIL)");
 904 }
 905
 906
 907
 908 /*
 909  * Spew the BODYSTRUCTURE data for a message.
 910  *
 911  */
 912 void imap_fetch_bodystructure (long msgnum, const char *item,
 913                 struct CtdlMessage *msg) {
 914         const char *rfc822 = NULL;
 915         const char *rfc822_body = NULL;
 916         size_t rfc822_len;
 917         size_t rfc822_headers_len;
 918         size_t rfc822_body_len;
 919         const char *ptr = NULL;
 920         char *pch;
 921         char buf[SIZ];
 922         int lines = 0;
 923
 924         /* Handle NULL message gracefully */
 925         if (msg == NULL) {
 926                 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
 927                         "(\"CHARSET\" \"US-ASCII\") NIL NIL "
 928                         "\"7BIT\" 0 0)");
 929                 return;
 930         }
 931
 932         /* For non-RFC822 (ordinary Citadel) messages, this is short and
 933          * sweet...
 934          */
 935         if (msg->cm_format_type != FMT_RFC822) {
 936
 937                 /* *sigh* We have to RFC822-format the message just to be able
 938                  * to measure it.  FIXME use smi cached fields if possible
 939                  */
 940
 941                 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
 942                 CtdlOutputPreLoadedMsg(msg, MT_RFC822, 0, 0, 1, SUPPRESS_ENV_TO);
 943                 rfc822_len = StrLength(CC->redirect_buffer);
 944                 rfc822 = pch = SmashStrBuf(&CC->redirect_buffer);
 945
 946                 ptr = rfc822;
 947                 do {
 948                         ptr = cmemreadline(ptr, buf, sizeof buf);
 949                         ++lines;
 950                         if ((IsEmptyStr(buf)) && (rfc822_body == NULL)) {
 951                                 rfc822_body = ptr;
 952                         }
 953                 } while (*ptr != 0);
 954
 955                 rfc822_headers_len = rfc822_body - rfc822;
 956                 rfc822_body_len = rfc822_len - rfc822_headers_len;
 957                 free(pch);
 958
 959                 cprintf("BODYSTRUCTURE (\"TEXT\" \"PLAIN\" "
 960                         "(\"CHARSET\" \"US-ASCII\") NIL NIL "
 961                         "\"7BIT\" " SIZE_T_FMT " %d)", rfc822_body_len, lines);
 962
 963                 return;
 964         }
 965
 966         /* For messages already stored in RFC822 format, we have to parse. */
 967         cprintf("BODYSTRUCTURE ");
 968         mime_parser(msg->cm_fields['M'],
 969                         NULL,
 970                         *imap_fetch_bodystructure_part, /* part */
 971                         *imap_fetch_bodystructure_pre,  /* pre-multi */
 972                         *imap_fetch_bodystructure_post, /* post-multi */
 973                         NULL,
 974                         1);     /* don't decode -- we want it as-is */
 975 }
 976
 977
 978 /*
 979  * imap_do_fetch() calls imap_do_fetch_msg() to output the data of an
 980  * individual message, once it has been selected for output.
 981  */
 982 void imap_do_fetch_msg(int seq, citimap_command *Cmd) {
 983         int i;
 984         citimap *Imap = IMAP;
 985         struct CtdlMessage *msg = NULL;
 986         int body_loaded = 0;
 987
 988         /* Don't attempt to fetch bogus messages or UID's */
 989         if (seq < 1) return;
 990         if (Imap->msgids[seq-1] < 1L) return;
 991
 992         buffer_output();
 993         cprintf("* %d FETCH (", seq);
 994
 995         for (i=0; i<Cmd->num_parms; ++i) {
 996
 997                 /* Fetchable without going to the message store at all */
 998                 if (!strcasecmp(Cmd->Params[i].Key, "UID")) {
 999                         imap_fetch_uid(seq);
1000                 }
1001                 else if (!strcasecmp(Cmd->Params[i].Key, "FLAGS")) {
1002                         imap_fetch_flags(seq-1);
1003                 }
1004
1005                 /* Potentially fetchable from cache, if the client requests
1006                  * stuff from the same message several times in a row.
1007                  */
1008                 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822")) {
1009                         imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1010                 }
1011                 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.HEADER")) {
1012                         imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1013                 }
1014                 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.SIZE")) {
1015                         imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1016                 }
1017                 else if (!strcasecmp(Cmd->Params[i].Key, "RFC822.TEXT")) {
1018                         imap_fetch_rfc822(Imap->msgids[seq-1], Cmd->Params[i].Key);
1019                 }
1020
1021                 /* BODY fetches do their own fetching and caching too. */
1022                 else if (!strncasecmp(Cmd->Params[i].Key, "BODY[", 5)) {
1023                         imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i], 0);
1024                 }
1025                 else if (!strncasecmp(Cmd->Params[i].Key, "BODY.PEEK[", 10)) {
1026                         imap_fetch_body(Imap->msgids[seq-1], Cmd->Params[i], 1);
1027                 }
1028
1029                 /* Otherwise, load the message into memory.
1030                  */
1031                 else if (!strcasecmp(Cmd->Params[i].Key, "BODYSTRUCTURE")) {
1032                         if ((msg != NULL) && (!body_loaded)) {
1033                                 CtdlFreeMessage(msg);   /* need the whole thing */
1034                                 msg = NULL;
1035                         }
1036                         if (msg == NULL) {
1037                                 msg = CtdlFetchMessage(Imap->msgids[seq-1], 1);
1038                                 body_loaded = 1;
1039                         }
1040                         imap_fetch_bodystructure(Imap->msgids[seq-1],
1041                                         Cmd->Params[i].Key, msg);
1042                 }
1043                 else if (!strcasecmp(Cmd->Params[i].Key, "ENVELOPE")) {
1044                         if (msg == NULL) {
1045                                 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0);
1046                                 body_loaded = 0;
1047                         }
1048                         imap_fetch_envelope(msg);
1049                 }
1050                 else if (!strcasecmp(Cmd->Params[i].Key, "INTERNALDATE")) {
1051                         if (msg == NULL) {
1052                                 msg = CtdlFetchMessage(Imap->msgids[seq-1], 0);
1053                                 body_loaded = 0;
1054                         }
1055                         imap_fetch_internaldate(msg);
1056                 }
1057
1058                 if (i != Cmd->num_parms-1) cprintf(" ");
1059         }
1060
1061         cprintf(")\r\n");
1062         unbuffer_output();
1063         if (msg != NULL) {
1064                 CtdlFreeMessage(msg);
1065         }
1066 }
1067
1068
1069
1070 /*
1071  * imap_fetch() calls imap_do_fetch() to do its actual work, once it's
1072  * validated and boiled down the request a bit.
1073  */
1074 void imap_do_fetch(citimap_command *Cmd) {
1075         int i;
1076 #if 0
1077 /* debug output the parsed vector */
1078         {
1079                 int i;
1080                 CtdlLogPrintf(CTDL_DEBUG, "----- %ld params \n",
1081                               Cmd->num_parms);
1082
1083         for (i=0; i < Cmd->num_parms; i++) {
1084                 if (Cmd->Params[i].len != strlen(Cmd->Params[i].Key))
1085                         CtdlLogPrintf(CTDL_DEBUG, "*********** %ld != %ld : %s\n",
1086                                       Cmd->Params[i].len,
1087                                       strlen(Cmd->Params[i].Key),
1088                                       Cmd->Params[i].Key);
1089                 else
1090                         CtdlLogPrintf(CTDL_DEBUG, "%ld : %s\n",
1091                                       Cmd->Params[i].len,
1092                                       Cmd->Params[i].Key);
1093         }}
1094
1095 #endif
1096
1097         if (IMAP->num_msgs > 0) {
1098                 for (i = 0; i < IMAP->num_msgs; ++i) {
1099
1100                         /* Abort the fetch loop if the session breaks.
1101                          * This is important for users who keep mailboxes
1102                          * that are too big *and* are too impatient to
1103                          * let them finish loading.  :)
1104                          */
1105                         if (CC->kill_me) return;
1106
1107                         /* Get any message marked for fetch. */
1108                         if (IMAP->flags[i] & IMAP_SELECTED) {
1109                                 imap_do_fetch_msg(i+1, Cmd);
1110                         }
1111                 }
1112         }
1113 }
1114
1115
1116
1117 /*
1118  * Back end for imap_handle_macros()
1119  * Note that this function *only* looks at the beginning of the string.  It
1120  * is not a generic search-and-replace function.
1121  */
1122 void imap_macro_replace(StrBuf *Buf, long where,
1123                         StrBuf *TmpBuf,
1124                         char *find, long findlen,
1125                         char *replace, long replacelen)
1126 {
1127
1128         if (StrLength(Buf) - where > findlen)
1129                 return;
1130
1131         if (!strncasecmp(ChrPtr(Buf) + where, find, findlen)) {
1132                 if (ChrPtr(Buf)[where + findlen] == ' ') {
1133                         StrBufPlain(TmpBuf, replace, replacelen);
1134                         StrBufAppendBufPlain(TmpBuf, HKEY(" "), 0);
1135                         StrBufReplaceToken(Buf, where, findlen,
1136                                            SKEY(TmpBuf));
1137                 }
1138                 if (where + findlen == StrLength(Buf)) {
1139                         StrBufReplaceToken(Buf, where, findlen,
1140                                            replace, replacelen);
1141                 }
1142         }
1143 }
1144
1145
1146
1147 /*
1148  * Handle macros embedded in FETCH data items.
1149  * (What the heck are macros doing in a wire protocol?  Are we trying to save
1150  * the computer at the other end the trouble of typing a lot of characters?)
1151  */
1152 void imap_handle_macros(citimap_command *Cmd) {
1153         long i;
1154         int nest = 0;
1155         StrBuf *Tmp = NewStrBuf();
1156
1157         for (i=0; i < StrLength(Cmd->CmdBuf); ++i) {
1158                 char ch = ChrPtr(Cmd->CmdBuf)[i];
1159                 if ((ch=='(') ||
1160                     (ch=='[') ||
1161                     (ch=='<') ||
1162                     (ch=='{')) ++nest;
1163                 else if ((ch==')') ||
1164                          (ch==']') ||
1165                          (ch=='>') ||
1166                          (ch=='}')) --nest;
1167
1168                 if (nest <= 0) {
1169                         imap_macro_replace(Cmd->CmdBuf, i,
1170                                            Tmp,
1171                                            HKEY("ALL"),
1172                                            HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE")
1173                         );
1174                         imap_macro_replace(Cmd->CmdBuf, i,
1175                                            Tmp,
1176                                            HKEY("BODY"),
1177                                            HKEY("BODYSTRUCTURE")
1178                         );
1179                         imap_macro_replace(Cmd->CmdBuf, i,
1180                                            Tmp,
1181                                            HKEY("FAST"),
1182                                            HKEY("FLAGS INTERNALDATE RFC822.SIZE")
1183                         );
1184                         imap_macro_replace(Cmd->CmdBuf, i,
1185                                            Tmp,
1186                                            HKEY("FULL"),
1187                                            HKEY("FLAGS INTERNALDATE RFC822.SIZE ENVELOPE BODY")
1188                         );
1189                 }
1190         }
1191         FreeStrBuf(&Tmp);
1192 }
1193
1194
1195 /*
1196  * Break out the data items requested, possibly a parenthesized list.
1197  * Returns the number of data items, or -1 if the list is invalid.
1198  * NOTE: this function alters the string it is fed, and uses it as a buffer
1199  * to hold the data for the pointers it returns.
1200  */
1201 int imap_extract_data_items(citimap_command *Cmd)
1202 {
1203         int nArgs;
1204         int nest = 0;
1205         const char *pch, *end;
1206         long initial_len;
1207
1208         /* Convert all whitespace to ordinary space characters. */
1209         pch = ChrPtr(Cmd->CmdBuf);
1210         end = pch + StrLength(Cmd->CmdBuf);
1211
1212         while (pch < end)
1213         {
1214                 if (isspace(*pch))
1215                         StrBufPeek(Cmd->CmdBuf, pch, 0, ' ');
1216                 pch++;
1217         }
1218
1219         /* Strip leading and trailing whitespace, then strip leading and
1220          * trailing parentheses if it's a list
1221          */
1222         StrBufTrim(Cmd->CmdBuf);
1223         pch = ChrPtr(Cmd->CmdBuf);
1224         if ( (pch[0]=='(') &&
1225              (pch[StrLength(Cmd->CmdBuf)-1]==')') )
1226         {
1227                 StrBufCutRight(Cmd->CmdBuf, 1);
1228                 StrBufCutLeft(Cmd->CmdBuf, 1);
1229                 StrBufTrim(Cmd->CmdBuf);
1230         }
1231
1232         /* Parse any macro data items */
1233         imap_handle_macros(Cmd);
1234
1235         /*
1236          * Now break out the data items.  We throw in one trailing space in
1237          * order to avoid having to break out the last one manually.
1238          */
1239         nArgs = StrLength(Cmd->CmdBuf) / 10 + 10;
1240         nArgs = CmdAdjust(Cmd, nArgs, 0);
1241         initial_len = StrLength(Cmd->CmdBuf);
1242         Cmd->num_parms = 0;
1243         Cmd->Params[Cmd->num_parms].Key = pch = ChrPtr(Cmd->CmdBuf);
1244         end = Cmd->Params[Cmd->num_parms].Key + StrLength(Cmd->CmdBuf);
1245
1246         while (pch < end)
1247         {
1248                 if ((*pch=='(') ||
1249                     (*pch=='[') ||
1250                     (*pch=='<') ||
1251                     (*pch=='{'))
1252                         ++nest;
1253
1254                 else if ((*pch==')') ||
1255                          (*pch==']') ||
1256                          (*pch=='>') ||
1257                          (*pch=='}'))
1258                         --nest;
1259
1260                 if ((nest <= 0) && (*pch==' ')) {
1261                         StrBufPeek(Cmd->CmdBuf, pch, 0, '\0');
1262                         Cmd->Params[Cmd->num_parms].len =
1263                                 pch - Cmd->Params[Cmd->num_parms].Key;
1264
1265                         if (Cmd->num_parms + 1 >= Cmd->avail_parms) {
1266                                 nArgs = CmdAdjust(Cmd, nArgs * 2, 1);
1267                         }
1268                         Cmd->num_parms++;
1269                         Cmd->Params[Cmd->num_parms].Key = ++pch;
1270                 }
1271                 else if (pch + 1 == end) {
1272                         Cmd->Params[Cmd->num_parms].len =
1273                                 pch - Cmd->Params[Cmd->num_parms].Key + 1;
1274
1275                         Cmd->num_parms++;
1276                 }
1277                 pch ++;
1278         }
1279         return Cmd->num_parms;
1280
1281 }
1282
1283
1284 /*
1285  * One particularly hideous aspect of IMAP is that we have to allow the client
1286  * to specify arbitrary ranges and/or sets of messages to fetch.  Citadel IMAP
1287  * handles this by setting the IMAP_SELECTED flag for each message specified in
1288  * the ranges/sets, then looping through the message array, outputting messages
1289  * with the flag set.  We don't bother returning an error if an out-of-range
1290  * number is specified (we just return quietly) because any client braindead
1291  * enough to request a bogus message number isn't going to notice the
1292  * difference anyway.
1293  *
1294  * This function clears out the IMAP_SELECTED bits, then sets that bit for each
1295  * message included in the specified range.
1296  *
1297  * Set is_uid to 1 to fetch by UID instead of sequence number.
1298  */
1299 void imap_pick_range(const char *supplied_range, int is_uid) {
1300         int i;
1301         int num_sets;
1302         int s;
1303         char setstr[SIZ], lostr[SIZ], histr[SIZ];
1304         long lo, hi;
1305         char actual_range[SIZ];
1306         citimap *Imap;
1307
1308         /*
1309          * Handle the "ALL" macro
1310          */
1311         if (!strcasecmp(supplied_range, "ALL")) {
1312                 safestrncpy(actual_range, "1:*", sizeof actual_range);
1313         }
1314         else {
1315                 safestrncpy(actual_range, supplied_range, sizeof actual_range);
1316         }
1317
1318         Imap = IMAP;
1319         /*
1320          * Clear out the IMAP_SELECTED flags for all messages.
1321          */
1322         for (i = 0; i < Imap->num_msgs; ++i) {
1323                 Imap->flags[i] = Imap->flags[i] & ~IMAP_SELECTED;
1324         }
1325
1326         /*
1327          * Now set it for all specified messages.
1328          */
1329         num_sets = num_tokens(actual_range, ',');
1330         for (s=0; s<num_sets; ++s) {
1331                 extract_token(setstr, actual_range, s, ',', sizeof setstr);
1332
1333                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
1334                 if (num_tokens(setstr, ':') >= 2) {
1335                         extract_token(histr, setstr, 1, ':', sizeof histr);
1336                         if (!strcmp(histr, "*")) snprintf(histr, sizeof histr, "%ld", LONG_MAX);
1337                 }
1338                 else {
1339                         safestrncpy(histr, lostr, sizeof histr);
1340                 }
1341                 lo = atol(lostr);
1342                 hi = atol(histr);
1343
1344                 /* Loop through the array, flipping bits where appropriate */
1345                 for (i = 1; i <= Imap->num_msgs; ++i) {
1346                         if (is_uid) {   /* fetch by sequence number */
1347                                 if ( (Imap->msgids[i-1]>=lo)
1348                                    && (Imap->msgids[i-1]<=hi)) {
1349                                         Imap->flags[i-1] |= IMAP_SELECTED;
1350                                 }
1351                         }
1352                         else {          /* fetch by uid */
1353                                 if ( (i>=lo) && (i<=hi)) {
1354                                         Imap->flags[i-1] |= IMAP_SELECTED;
1355                                 }
1356                         }
1357                 }
1358         }
1359 }
1360
1361
1362
1363 /*
1364  * This function is called by the main command loop.
1365  */
1366 void imap_fetch(int num_parms, ConstStr *Params) {
1367         citimap_command Cmd;
1368         int num_items;
1369
1370         if (num_parms < 4) {
1371                 cprintf("%s BAD invalid parameters\r\n", Params[0].Key);
1372                 return;
1373         }
1374
1375         imap_pick_range(Params[2].Key, 0);
1376
1377         memset(&Cmd, 0, sizeof(citimap_command));
1378         Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1379         MakeStringOf(Cmd.CmdBuf, 3);
1380
1381         num_items = imap_extract_data_items(&Cmd);
1382         if (num_items < 1) {
1383                 cprintf("%s BAD invalid data item list\r\n", Params[0].Key);
1384                 FreeStrBuf(&Cmd.CmdBuf);
1385                 free(Cmd.Params);
1386                 return;
1387         }
1388
1389         imap_do_fetch(&Cmd);
1390         cprintf("%s OK FETCH completed\r\n", Params[0].Key);
1391         FreeStrBuf(&Cmd.CmdBuf);
1392         free(Cmd.Params);
1393 }
1394
1395 /*
1396  * This function is called by the main command loop.
1397  */
1398 void imap_uidfetch(int num_parms, ConstStr *Params) {
1399         citimap_command Cmd;
1400         int num_items;
1401         int i;
1402         int have_uid_item = 0;
1403
1404         if (num_parms < 5) {
1405                 cprintf("%s BAD invalid parameters\r\n", Params[0].Key);
1406                 return;
1407         }
1408
1409         imap_pick_range(Params[3].Key, 1);
1410
1411         memset(&Cmd, 0, sizeof(citimap_command));
1412         Cmd.CmdBuf = NewStrBufPlain(NULL, StrLength(IMAP->Cmd.CmdBuf));
1413
1414         MakeStringOf(Cmd.CmdBuf, 4);
1415 #if 0
1416         CtdlLogPrintf(CTDL_DEBUG, "-------%s--------\n", ChrPtr(Cmd.CmdBuf));
1417 #endif
1418         num_items = imap_extract_data_items(&Cmd);
1419         if (num_items < 1) {
1420                 cprintf("%s BAD invalid data item list\r\n", Params[0].Key);
1421                 FreeStrBuf(&Cmd.CmdBuf);
1422                 free(Cmd.Params);
1423                 return;
1424         }
1425
1426         /* If the "UID" item was not included, we include it implicitly
1427          * (at the beginning) because this is a UID FETCH command
1428          */
1429         for (i=0; i<num_items; ++i) {
1430                 if (!strcasecmp(Cmd.Params[i].Key, "UID")) ++have_uid_item;
1431         }
1432         if (have_uid_item == 0) {
1433                 if (Cmd.num_parms + 1 >= Cmd.avail_parms)
1434                         CmdAdjust(&Cmd, Cmd.avail_parms + 1, 1);
1435                 memmove(&Cmd.Params[1],
1436                         &Cmd.Params[0],
1437                         sizeof(ConstStr) * Cmd.num_parms);
1438
1439                 Cmd.num_parms++;
1440                 Cmd.Params[0] = (ConstStr){HKEY("UID")};
1441         }
1442
1443         imap_do_fetch(&Cmd);
1444         cprintf("%s OK UID FETCH completed\r\n", Params[0].Key);
1445         FreeStrBuf(&Cmd.CmdBuf);
1446         free(Cmd.Params);
1447 }
1448
1449