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