citadel/modules/imap/imap_fetch.c

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