citadel/modules/imap/serv_imap.c

   1 /*
   2  * $Id$
   3  *
   4  * IMAP server for the Citadel system
   5  * Copyright (C) 2000-2009 by Art Cancro and others.
   6  * This code is released under the terms of the GNU General Public License.
   7  *
   8  * WARNING: the IMAP protocol is badly designed.  No implementation of it
   9  * is perfect.  Indeed, with so much gratuitous complexity, *all* IMAP
  10  * implementations have bugs.
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  25  */
  26
  27 #include "sysdep.h"
  28 #include <stdlib.h>
  29 #include <unistd.h>
  30 #include <stdio.h>
  31 #include <fcntl.h>
  32 #include <signal.h>
  33 #include <pwd.h>
  34 #include <errno.h>
  35 #include <sys/types.h>
  36
  37 #if TIME_WITH_SYS_TIME
  38 # include <sys/time.h>
  39 # include <time.h>
  40 #else
  41 # if HAVE_SYS_TIME_H
  42 #  include <sys/time.h>
  43 # else
  44 #  include <time.h>
  45 # endif
  46 #endif
  47
  48 #include <sys/wait.h>
  49 #include <ctype.h>
  50 #include <string.h>
  51 #include <limits.h>
  52 #include <libcitadel.h>
  53 #include "citadel.h"
  54 #include "server.h"
  55 #include "citserver.h"
  56 #include "support.h"
  57 #include "config.h"
  58 #include "user_ops.h"
  59 #include "policy.h"
  60 #include "database.h"
  61 #include "msgbase.h"
  62 #include "internet_addressing.h"
  63 #include "imap_tools.h"
  64 #include "serv_imap.h"
  65 #include "imap_list.h"
  66 #include "imap_fetch.h"
  67 #include "imap_search.h"
  68 #include "imap_store.h"
  69 #include "imap_acl.h"
  70 #include "imap_metadata.h"
  71 #include "imap_misc.h"
  72
  73 #include "ctdl_module.h"
  74
  75
  76 /* imap_rename() uses this struct containing list of rooms to rename */
  77 struct irl {
  78         struct irl *next;
  79         char irl_oldroom[ROOMNAMELEN];
  80         char irl_newroom[ROOMNAMELEN];
  81         int irl_newfloor;
  82 };
  83
  84 /* Data which is passed between imap_rename() and imap_rename_backend() */
  85 struct irlparms {
  86         char *oldname;
  87         char *newname;
  88         struct irl **irl;
  89 };
  90
  91
  92 /*
  93  * If there is a message ID map in memory, free it
  94  */
  95 void imap_free_msgids(void)
  96 {
  97         if (IMAP->msgids != NULL) {
  98                 free(IMAP->msgids);
  99                 IMAP->msgids = NULL;
 100                 IMAP->num_msgs = 0;
 101                 IMAP->num_alloc = 0;
 102         }
 103         if (IMAP->flags != NULL) {
 104                 free(IMAP->flags);
 105                 IMAP->flags = NULL;
 106         }
 107         IMAP->last_mtime = (-1);
 108 }
 109
 110
 111 /*
 112  * If there is a transmitted message in memory, free it
 113  */
 114 void imap_free_transmitted_message(void)
 115 {
 116         FreeStrBuf(&IMAP->TransmittedMessage);
 117 }
 118
 119
 120 /*
 121  * Set the \Seen, \Recent. and \Answered flags, based on the sequence
 122  * sets stored in the visit record for this user/room.  Note that we have
 123  * to parse each sequence set manually here, because calling the utility
 124  * function is_msg_in_sequence_set() over and over again is too expensive.
 125  *
 126  * first_msg should be set to 0 to rescan the flags for every message in the
 127  * room, or some other value if we're only interested in an incremental
 128  * update.
 129  */
 130 void imap_set_seen_flags(int first_msg)
 131 {
 132         struct visit vbuf;
 133         int i;
 134         int num_sets;
 135         int s;
 136         char setstr[64], lostr[64], histr[64];
 137         long lo, hi;
 138
 139         if (IMAP->num_msgs < 1) return;
 140         CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
 141
 142         for (i = first_msg; i < IMAP->num_msgs; ++i) {
 143                 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_SEEN;
 144                 IMAP->flags[i] |= IMAP_RECENT;
 145                 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_ANSWERED;
 146         }
 147
 148         /*
 149          * Do the "\Seen" flag.
 150          * (Any message not "\Seen" is considered "\Recent".)
 151          */
 152         num_sets = num_tokens(vbuf.v_seen, ',');
 153         for (s=0; s<num_sets; ++s) {
 154                 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
 155
 156                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
 157                 if (num_tokens(setstr, ':') >= 2) {
 158                         extract_token(histr, setstr, 1, ':', sizeof histr);
 159                         if (!strcmp(histr, "*")) {
 160                                 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
 161                         }
 162                 }
 163                 else {
 164                         strcpy(histr, lostr);
 165                 }
 166                 lo = atol(lostr);
 167                 hi = atol(histr);
 168
 169                 for (i = first_msg; i < IMAP->num_msgs; ++i) {
 170                         if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
 171                                 IMAP->flags[i] |= IMAP_SEEN;
 172                                 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_RECENT;
 173                         }
 174                 }
 175         }
 176
 177         /* Do the ANSWERED flag */
 178         num_sets = num_tokens(vbuf.v_answered, ',');
 179         for (s=0; s<num_sets; ++s) {
 180                 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
 181
 182                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
 183                 if (num_tokens(setstr, ':') >= 2) {
 184                         extract_token(histr, setstr, 1, ':', sizeof histr);
 185                         if (!strcmp(histr, "*")) {
 186                                 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
 187                         }
 188                 }
 189                 else {
 190                         strcpy(histr, lostr);
 191                 }
 192                 lo = atol(lostr);
 193                 hi = atol(histr);
 194
 195                 for (i = first_msg; i < IMAP->num_msgs; ++i) {
 196                         if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
 197                                 IMAP->flags[i] |= IMAP_ANSWERED;
 198                         }
 199                 }
 200         }
 201
 202 }
 203
 204
 205
 206 /*
 207  * Back end for imap_load_msgids()
 208  *
 209  * Optimization: instead of calling realloc() to add each message, we
 210  * allocate space in the list for REALLOC_INCREMENT messages at a time.  This
 211  * allows the mapping to proceed much faster.
 212  */
 213 void imap_add_single_msgid(long msgnum, void *userdata)
 214 {
 215
 216         ++IMAP->num_msgs;
 217         if (IMAP->num_msgs > IMAP->num_alloc) {
 218                 IMAP->num_alloc += REALLOC_INCREMENT;
 219                 IMAP->msgids = realloc(IMAP->msgids, (IMAP->num_alloc * sizeof(long)) );
 220                 IMAP->flags = realloc(IMAP->flags, (IMAP->num_alloc * sizeof(long)) );
 221         }
 222         IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
 223         IMAP->flags[IMAP->num_msgs - 1] = 0;
 224 }
 225
 226
 227
 228 /*
 229  * Set up a message ID map for the current room (folder)
 230  */
 231 void imap_load_msgids(void)
 232 {
 233         struct cdbdata *cdbfr;
 234
 235         if (IMAP->selected == 0) {
 236                 CtdlLogPrintf(CTDL_ERR,
 237                         "imap_load_msgids() can't run; no room selected\n");
 238                 return;
 239         }
 240
 241         imap_free_msgids();     /* If there was already a map, free it */
 242
 243         /* Load the message list */
 244         cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
 245         if (cdbfr != NULL) {
 246                 IMAP->msgids = malloc(cdbfr->len);
 247                 memcpy(IMAP->msgids, cdbfr->ptr, cdbfr->len);
 248                 IMAP->num_msgs = cdbfr->len / sizeof(long);
 249                 IMAP->num_alloc = cdbfr->len / sizeof(long);
 250                 cdb_free(cdbfr);
 251         }
 252
 253         if (IMAP->num_msgs) {
 254                 IMAP->flags = malloc(IMAP->num_alloc * sizeof(long));
 255                 memset(IMAP->flags, 0, (IMAP->num_alloc * sizeof(long)) );
 256         }
 257
 258         imap_set_seen_flags(0);
 259 }
 260
 261
 262 /*
 263  * Re-scan the selected room (folder) and see if it's been changed at all
 264  */
 265 void imap_rescan_msgids(void)
 266 {
 267
 268         int original_num_msgs = 0;
 269         long original_highest = 0L;
 270         int i, j, jstart;
 271         int message_still_exists;
 272         struct cdbdata *cdbfr;
 273         long *msglist = NULL;
 274         int num_msgs = 0;
 275         int num_recent = 0;
 276
 277         if (IMAP->selected == 0) {
 278                 CtdlLogPrintf(CTDL_ERR, "imap_load_msgids() can't run; no room selected\n");
 279                 return;
 280         }
 281
 282         /*
 283          * Check to see if the room's contents have changed.
 284          * If not, we can avoid this rescan.
 285          */
 286         CtdlGetRoom(&CC->room, CC->room.QRname);
 287         if (IMAP->last_mtime == CC->room.QRmtime) {     /* No changes! */
 288                 return;
 289         }
 290
 291         /* Load the *current* message list from disk, so we can compare it
 292          * to what we have in memory.
 293          */
 294         cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
 295         if (cdbfr != NULL) {
 296                 msglist = malloc(cdbfr->len);
 297                 if (msglist == NULL) {
 298                         CtdlLogPrintf(CTDL_CRIT, "malloc() failed\n");
 299                         abort();
 300                 }
 301                 memcpy(msglist, cdbfr->ptr, (size_t)cdbfr->len);
 302                 num_msgs = cdbfr->len / sizeof(long);
 303                 cdb_free(cdbfr);
 304         } else {
 305                 num_msgs = 0;
 306         }
 307
 308         /*
 309          * Check to see if any of the messages we know about have been expunged
 310          */
 311         if (IMAP->num_msgs > 0) {
 312                 jstart = 0;
 313                 for (i = 0; i < IMAP->num_msgs; ++i) {
 314
 315                         message_still_exists = 0;
 316                         if (num_msgs > 0) {
 317                                 for (j = jstart; j < num_msgs; ++j) {
 318                                         if (msglist[j] == IMAP->msgids[i]) {
 319                                                 message_still_exists = 1;
 320                                                 jstart = j;
 321                                                 break;
 322                                         }
 323                                 }
 324                         }
 325
 326                         if (message_still_exists == 0) {
 327                                 cprintf("* %d EXPUNGE\r\n", i + 1);
 328
 329                                 /* Here's some nice stupid nonsense.  When a
 330                                  * message is expunged, we have to slide all
 331                                  * the existing messages up in the message
 332                                  * array.
 333                                  */
 334                                 --IMAP->num_msgs;
 335                                 memcpy(&IMAP->msgids[i],
 336                                        &IMAP->msgids[i + 1],
 337                                        (sizeof(long) *
 338                                         (IMAP->num_msgs - i)));
 339                                 memcpy(&IMAP->flags[i],
 340                                        &IMAP->flags[i + 1],
 341                                        (sizeof(long) *
 342                                         (IMAP->num_msgs - i)));
 343
 344                                 --i;
 345                         }
 346
 347                 }
 348         }
 349
 350         /*
 351          * Remember how many messages were here before we re-scanned.
 352          */
 353         original_num_msgs = IMAP->num_msgs;
 354         if (IMAP->num_msgs > 0) {
 355                 original_highest = IMAP->msgids[IMAP->num_msgs - 1];
 356         } else {
 357                 original_highest = 0L;
 358         }
 359
 360         /*
 361          * Now peruse the room for *new* messages only.
 362          * This logic is probably the cause of Bug # 368
 363          * [ http://bugzilla.citadel.org/show_bug.cgi?id=368 ]
 364          */
 365         if (num_msgs > 0) {
 366                 for (j = 0; j < num_msgs; ++j) {
 367                         if (msglist[j] > original_highest) {
 368                                 imap_add_single_msgid(msglist[j], NULL);
 369                         }
 370                 }
 371         }
 372         imap_set_seen_flags(original_num_msgs);
 373
 374         /*
 375          * If new messages have arrived, tell the client about them.
 376          */
 377         if (IMAP->num_msgs > original_num_msgs) {
 378
 379                 for (j = 0; j < num_msgs; ++j) {
 380                         if (IMAP->flags[j] & IMAP_RECENT) {
 381                                 ++num_recent;
 382                         }
 383                 }
 384
 385                 cprintf("* %d EXISTS\r\n", IMAP->num_msgs);
 386                 cprintf("* %d RECENT\r\n", num_recent);
 387         }
 388
 389         if (num_msgs != 0) {
 390                 free(msglist);
 391         }
 392         IMAP->last_mtime = CC->room.QRmtime;
 393 }
 394
 395
 396 /*
 397  * This cleanup function blows away the temporary memory and files used by
 398  * the IMAP server.
 399  */
 400 void imap_cleanup_function(void)
 401 {
 402
 403         /* Don't do this stuff if this is not a IMAP session! */
 404         if (CC->h_command_function != imap_command_loop)
 405                 return;
 406
 407         /* If there is a mailbox selected, auto-expunge it. */
 408         if (IMAP->selected) {
 409                 imap_do_expunge();
 410         }
 411
 412         CtdlLogPrintf(CTDL_DEBUG, "Performing IMAP cleanup hook\n");
 413         imap_free_msgids();
 414         imap_free_transmitted_message();
 415
 416         if (IMAP->cached_rfc822_data != NULL) {
 417                 free(IMAP->cached_rfc822_data);
 418                 IMAP->cached_rfc822_data = NULL;
 419                 IMAP->cached_rfc822_msgnum = (-1);
 420                 IMAP->cached_rfc822_withbody = 0;
 421         }
 422
 423         if (IMAP->cached_body != NULL) {
 424                 free(IMAP->cached_body);
 425                 IMAP->cached_body = NULL;
 426                 IMAP->cached_body_len = 0;
 427                 IMAP->cached_bodymsgnum = (-1);
 428         }
 429
 430         free(IMAP);
 431         CtdlLogPrintf(CTDL_DEBUG, "Finished IMAP cleanup hook\n");
 432 }
 433
 434
 435 /*
 436  * Does the actual work of the CAPABILITY command (because we need to
 437  * output this stuff in other places as well)
 438  */
 439 void imap_output_capability_string(void) {
 440         cprintf("CAPABILITY IMAP4REV1 NAMESPACE ID AUTH=PLAIN AUTH=LOGIN UIDPLUS");
 441
 442 #ifdef HAVE_OPENSSL
 443         if (!CC->redirect_ssl) cprintf(" STARTTLS");
 444 #endif
 445
 446 #ifndef DISABLE_IMAP_ACL
 447         cprintf(" ACL");
 448 #endif
 449
 450         /* We are building a partial implementation of METADATA for the sole purpose
 451          * of interoperating with the ical/vcard version of the Bynari Insight Connector.
 452          * It is not a full RFC5464 implementation, but it should refuse non-Bynari
 453          * metadata in a compatible and graceful way.
 454          */
 455         cprintf(" METADATA");
 456
 457         /*
 458          * LIST-EXTENDED was originally going to be required by the METADATA extension.
 459          * It was mercifully removed prior to the finalization of RFC5464.  We started
 460          * implementing this but stopped when we learned that it would not be needed.
 461          * If you uncomment this declaration you are responsible for writing a lot of new
 462          * code.
 463          *
 464          * cprintf(" LIST-EXTENDED")
 465          */
 466 }
 467
 468
 469 /*
 470  * implements the CAPABILITY command
 471  */
 472 void imap_capability(int num_parms, ConstStr *Params)
 473 {
 474         cprintf("* ");
 475         imap_output_capability_string();
 476         cprintf("\r\n");
 477         cprintf("%s OK CAPABILITY completed\r\n", Params[0].Key);
 478 }
 479
 480
 481 /*
 482  * Implements the ID command (specified by RFC2971)
 483  *
 484  * We ignore the client-supplied information, and output a NIL response.
 485  * Although this is technically a valid implementation of the extension, it
 486  * is quite useless.  It exists only so that we may see which clients are
 487  * making use of this extension.
 488  *
 489  */
 490 void imap_id(int num_parms, ConstStr *Params)
 491 {
 492         cprintf("* ID NIL\r\n");
 493         cprintf("%s OK ID completed\r\n", Params[0].Key);
 494 }
 495
 496
 497 /*
 498  * Here's where our IMAP session begins its happy day.
 499  */
 500 void imap_greeting(void)
 501 {
 502
 503         strcpy(CC->cs_clientname, "IMAP session");
 504         CC->session_specific_data = malloc(sizeof(citimap));
 505         memset(IMAP, 0, sizeof(citimap));
 506         IMAP->authstate = imap_as_normal;
 507         IMAP->cached_rfc822_data = NULL;
 508         IMAP->cached_rfc822_msgnum = (-1);
 509         IMAP->cached_rfc822_withbody = 0;
 510
 511         if (CC->nologin)
 512         {
 513                 cprintf("* BYE; Server busy, try later\r\n");
 514                 CC->kill_me = 1;
 515                 return;
 516         }
 517         cprintf("* OK [");
 518         imap_output_capability_string();
 519         cprintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
 520 }
 521
 522
 523 /*
 524  * IMAPS is just like IMAP, except it goes crypto right away.
 525  */
 526 void imaps_greeting(void) {
 527         CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
 528 #ifdef HAVE_OPENSSL
 529         if (!CC->redirect_ssl) CC->kill_me = 1;         /* kill session if no crypto */
 530 #endif
 531         imap_greeting();
 532 }
 533
 534
 535 /*
 536  * implements the LOGIN command (ordinary username/password login)
 537  */
 538 void imap_login(int num_parms, ConstStr *Params)
 539 {
 540
 541         switch (num_parms) {
 542         case 3:
 543                 if (Params[2].Key[0] == '{') {
 544                         cprintf("+ go ahead\r\n");
 545                         IMAP->authstate = imap_as_expecting_multilineusername;
 546                         strcpy(IMAP->authseq, Params[0].Key);
 547                         return;
 548                 }
 549                 else {
 550                         cprintf("%s BAD incorrect number of parameters\r\n", Params[0].Key);
 551                         return;
 552                 }
 553         case 4:
 554                 if (CtdlLoginExistingUser(NULL, Params[2].Key) == login_ok) {
 555                         if (CtdlTryPassword(Params[3].Key) == pass_ok) {
 556                                 cprintf("%s OK [", Params[0].Key);
 557                                 imap_output_capability_string();
 558                                 cprintf("] Hello, %s\r\n", CC->user.fullname);
 559                                 return;
 560                         }
 561                 }
 562
 563                 cprintf("%s BAD Login incorrect\r\n", Params[0].Key);
 564         default:
 565                 cprintf("%s BAD incorrect number of parameters\r\n", Params[0].Key);
 566                 return;
 567         }
 568
 569 }
 570
 571
 572 /*
 573  * Implements the AUTHENTICATE command
 574  */
 575 void imap_authenticate(int num_parms, ConstStr *Params)
 576 {
 577         char buf[SIZ];
 578
 579         if (num_parms != 3) {
 580                 cprintf("%s BAD incorrect number of parameters\r\n",
 581                         Params[0].Key);
 582                 return;
 583         }
 584
 585         if (CC->logged_in) {
 586                 cprintf("%s BAD Already logged in.\r\n", Params[0].Key);
 587                 return;
 588         }
 589
 590         if (!strcasecmp(Params[2].Key, "LOGIN")) {
 591                 CtdlEncodeBase64(buf, "Username:", 9, 0);
 592                 cprintf("+ %s\r\n", buf);
 593                 IMAP->authstate = imap_as_expecting_username;
 594                 strcpy(IMAP->authseq, Params[0].Key);
 595                 return;
 596         }
 597
 598         if (!strcasecmp(Params[2].Key, "PLAIN")) {
 599                 // CtdlEncodeBase64(buf, "Username:", 9, 0);
 600                 // cprintf("+ %s\r\n", buf);
 601                 cprintf("+ \r\n");
 602                 IMAP->authstate = imap_as_expecting_plainauth;
 603                 strcpy(IMAP->authseq, Params[0].Key);
 604                 return;
 605         }
 606
 607         else {
 608                 cprintf("%s NO AUTHENTICATE %s failed\r\n",
 609                         Params[0].Key, Params[1].Key);
 610         }
 611 }
 612
 613
 614 void imap_auth_plain(void)
 615 {
 616         const char *decoded_authstring;
 617         char ident[256];
 618         char user[256];
 619         char pass[256];
 620         int result;
 621
 622         memset(pass, 0, sizeof(pass));
 623         StrBufDecodeBase64(IMAP->Cmd.CmdBuf);
 624
 625         decoded_authstring = ChrPtr(IMAP->Cmd.CmdBuf);
 626         safestrncpy(ident, decoded_authstring, sizeof ident);
 627         safestrncpy(user, &decoded_authstring[strlen(ident) + 1], sizeof user);
 628         safestrncpy(pass, &decoded_authstring[strlen(ident) + strlen(user) + 2], sizeof pass);
 629
 630         IMAP->authstate = imap_as_normal;
 631
 632         if (!IsEmptyStr(ident)) {
 633                 result = CtdlLoginExistingUser(user, ident);
 634         }
 635         else {
 636                 result = CtdlLoginExistingUser(NULL, user);
 637         }
 638
 639         if (result == login_ok) {
 640                 if (CtdlTryPassword(pass) == pass_ok) {
 641                         cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
 642                         return;
 643                 }
 644         }
 645         cprintf("%s NO authentication failed\r\n", IMAP->authseq);
 646 }
 647
 648
 649 void imap_auth_login_user(long state)
 650 {
 651         char buf[SIZ];
 652         citimap *Imap = IMAP;
 653
 654         switch (state){
 655         case imap_as_expecting_username:
 656                 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
 657                 CtdlLoginExistingUser(NULL, ChrPtr(Imap->Cmd.CmdBuf));
 658                 CtdlEncodeBase64(buf, "Password:", 9, 0);
 659                 cprintf("+ %s\r\n", buf);
 660
 661                 Imap->authstate = imap_as_expecting_password;
 662                 return;
 663         case imap_as_expecting_multilineusername:
 664                 extract_token(buf, ChrPtr(Imap->Cmd.CmdBuf), 1, ' ', sizeof(buf));
 665                 CtdlLoginExistingUser(NULL, ChrPtr(Imap->Cmd.CmdBuf));
 666                 cprintf("+ go ahead\r\n");
 667                 IMAP->authstate = imap_as_expecting_multilinepassword;
 668                 return;
 669         }
 670 }
 671
 672
 673 void imap_auth_login_pass(long state)
 674 {
 675         citimap *Imap = IMAP;
 676         const char *pass = NULL;
 677         char buf[SIZ];
 678
 679         switch (state) {
 680         default:
 681         case imap_as_expecting_password:
 682                 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
 683                 pass = buf;
 684                 break;
 685         case imap_as_expecting_multilinepassword:
 686                 pass = ChrPtr(Imap->Cmd.CmdBuf);
 687                 break;
 688         }
 689         if (CtdlTryPassword(pass) == pass_ok) {
 690                 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
 691         } else {
 692                 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
 693         }
 694         IMAP->authstate = imap_as_normal;
 695         return;
 696 }
 697
 698
 699 /*
 700  * implements the STARTTLS command (Citadel API version)
 701  */
 702 void imap_starttls(int num_parms, ConstStr *Params)
 703 {
 704         char ok_response[SIZ];
 705         char nosup_response[SIZ];
 706         char error_response[SIZ];
 707
 708         sprintf(ok_response,    "%s OK begin TLS negotiation now\r\n",  Params[0].Key);
 709         sprintf(nosup_response, "%s NO TLS not supported here\r\n",     Params[0].Key);
 710         sprintf(error_response, "%s BAD Internal error\r\n",            Params[0].Key);
 711         CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
 712 }
 713
 714
 715 /*
 716  * implements the SELECT command
 717  */
 718 void imap_select(int num_parms, ConstStr *Params)
 719 {
 720         char towhere[SIZ];
 721         char augmented_roomname[ROOMNAMELEN];
 722         int c = 0;
 723         int ok = 0;
 724         int ra = 0;
 725         struct ctdlroom QRscratch;
 726         int msgs, new;
 727         int floornum;
 728         int roomflags;
 729         int i;
 730
 731         /* Convert the supplied folder name to a roomname */
 732         i = imap_roomname(towhere, sizeof towhere, Params[2].Key);
 733         if (i < 0) {
 734                 cprintf("%s NO Invalid mailbox name.\r\n", Params[0].Key);
 735                 IMAP->selected = 0;
 736                 return;
 737         }
 738         floornum = (i & 0x00ff);
 739         roomflags = (i & 0xff00);
 740
 741         /* First try a regular match */
 742         c = CtdlGetRoom(&QRscratch, towhere);
 743
 744         /* Then try a mailbox name match */
 745         if (c != 0) {
 746                 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, towhere);
 747                 c = CtdlGetRoom(&QRscratch, augmented_roomname);
 748                 if (c == 0) {
 749                         strcpy(towhere, augmented_roomname);
 750                 }
 751         }
 752
 753         /* If the room exists, check security/access */
 754         if (c == 0) {
 755                 /* See if there is an existing user/room relationship */
 756                 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
 757
 758                 /* normal clients have to pass through security */
 759                 if (ra & UA_KNOWN) {
 760                         ok = 1;
 761                 }
 762         }
 763
 764         /* Fail here if no such room */
 765         if (!ok) {
 766                 cprintf("%s NO ... no such room, or access denied\r\n", Params[0].Key);
 767                 return;
 768         }
 769
 770         /* If we already had some other folder selected, auto-expunge it */
 771         imap_do_expunge();
 772
 773         /*
 774          * CtdlUserGoto() formally takes us to the desired room, happily returning
 775          * the number of messages and number of new messages.
 776          */
 777         memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
 778         CtdlUserGoto(NULL, 0, 0, &msgs, &new);
 779         IMAP->selected = 1;
 780
 781         if (!strcasecmp(Params[1].Key, "EXAMINE")) {
 782                 IMAP->readonly = 1;
 783         } else {
 784                 IMAP->readonly = 0;
 785         }
 786
 787         imap_load_msgids();
 788         IMAP->last_mtime = CC->room.QRmtime;
 789
 790         cprintf("* %d EXISTS\r\n", msgs);
 791         cprintf("* %d RECENT\r\n", new);
 792
 793         cprintf("* OK [UIDVALIDITY %ld] UID validity status\r\n", GLOBAL_UIDVALIDITY_VALUE);
 794         cprintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
 795
 796         /* Technically, \Deleted is a valid flag, but not a permanent flag,
 797          * because we don't maintain its state across sessions.  Citadel
 798          * automatically expunges mailboxes when they are de-selected.
 799          *
 800          * Unfortunately, omitting \Deleted as a PERMANENTFLAGS flag causes
 801          * some clients (particularly Thunderbird) to misbehave -- they simply
 802          * elect not to transmit the flag at all.  So we have to advertise
 803          * \Deleted as a PERMANENTFLAGS flag, even though it technically isn't.
 804          */
 805         cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
 806         cprintf("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] permanent flags\r\n");
 807
 808         cprintf("%s OK [%s] %s completed\r\n",
 809                 Params[0].Key,
 810                 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), Params[1].Key
 811         );
 812 }
 813
 814
 815 /*
 816  * Does the real work for expunge.
 817  */
 818 int imap_do_expunge(void)
 819 {
 820         int i;
 821         int num_expunged = 0;
 822         long *delmsgs = NULL;
 823         int num_delmsgs = 0;
 824
 825         CtdlLogPrintf(CTDL_DEBUG, "imap_do_expunge() called\n");
 826         if (IMAP->selected == 0) {
 827                 return (0);
 828         }
 829
 830         if (IMAP->num_msgs > 0) {
 831                 delmsgs = malloc(IMAP->num_msgs * sizeof(long));
 832                 for (i = 0; i < IMAP->num_msgs; ++i) {
 833                         if (IMAP->flags[i] & IMAP_DELETED) {
 834                                 delmsgs[num_delmsgs++] = IMAP->msgids[i];
 835                         }
 836                 }
 837                 if (num_delmsgs > 0) {
 838                         CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
 839                 }
 840                 num_expunged += num_delmsgs;
 841                 free(delmsgs);
 842         }
 843
 844         if (num_expunged > 0) {
 845                 imap_rescan_msgids();
 846         }
 847
 848         CtdlLogPrintf(CTDL_DEBUG, "Expunged %d messages from <%s>\n", num_expunged, CC->room.QRname);
 849         return (num_expunged);
 850 }
 851
 852
 853 /*
 854  * implements the EXPUNGE command syntax
 855  */
 856 void imap_expunge(int num_parms, ConstStr *Params)
 857 {
 858         int num_expunged = 0;
 859
 860         num_expunged = imap_do_expunge();
 861         cprintf("%s OK expunged %d messages.\r\n", Params[0].Key, num_expunged);
 862 }
 863
 864
 865 /*
 866  * implements the CLOSE command
 867  */
 868 void imap_close(int num_parms, ConstStr *Params)
 869 {
 870
 871         /* Yes, we always expunge on close. */
 872         if (IMAP->selected) {
 873                 imap_do_expunge();
 874         }
 875
 876         IMAP->selected = 0;
 877         IMAP->readonly = 0;
 878         imap_free_msgids();
 879         cprintf("%s OK CLOSE completed\r\n", Params[0].Key);
 880 }
 881
 882
 883 /*
 884  * Implements the NAMESPACE command.
 885  */
 886 void imap_namespace(int num_parms, ConstStr *Params)
 887 {
 888         int i;
 889         struct floor *fl;
 890         int floors = 0;
 891         char buf[SIZ];
 892
 893         cprintf("* NAMESPACE ");
 894
 895         /* All personal folders are subordinate to INBOX. */
 896         cprintf("((\"INBOX/\" \"/\")) ");
 897
 898         /* Other users' folders ... coming soon! FIXME */
 899         cprintf("NIL ");
 900
 901         /* Show all floors as shared namespaces.  Neato! */
 902         cprintf("(");
 903         for (i = 0; i < MAXFLOORS; ++i) {
 904                 fl = CtdlGetCachedFloor(i);
 905                 if (fl->f_flags & F_INUSE) {
 906                         if (floors > 0) cprintf(" ");
 907                         cprintf("(");
 908                         sprintf(buf, "%s/", fl->f_name);
 909                         plain_imap_strout(buf);
 910                         cprintf(" \"/\")");
 911                         ++floors;
 912                 }
 913         }
 914         cprintf(")");
 915
 916         /* Wind it up with a newline and a completion message. */
 917         cprintf("\r\n");
 918         cprintf("%s OK NAMESPACE completed\r\n", Params[0].Key);
 919 }
 920
 921
 922 /*
 923  * Implements the CREATE command
 924  *
 925  */
 926 void imap_create(int num_parms, ConstStr *Params)
 927 {
 928         int ret;
 929         char roomname[ROOMNAMELEN];
 930         int floornum;
 931         int flags;
 932         int newroomtype = 0;
 933         int newroomview = 0;
 934         char *notification_message = NULL;
 935
 936         if (num_parms < 3) {
 937                 cprintf("%s NO A foder name must be specified\r\n", Params[0].Key);
 938                 return;
 939         }
 940
 941         if (strchr(Params[2].Key, '\\') != NULL) {
 942                 cprintf("%s NO Invalid character in folder name\r\n", Params[0].Key);
 943                 CtdlLogPrintf(CTDL_DEBUG, "invalid character in folder name\n");
 944                 return;
 945         }
 946
 947         ret = imap_roomname(roomname, sizeof roomname, Params[2].Key);
 948         if (ret < 0) {
 949                 cprintf("%s NO Invalid mailbox name or location\r\n",
 950                         Params[0].Key);
 951                 CtdlLogPrintf(CTDL_DEBUG, "invalid mailbox name or location\n");
 952                 return;
 953         }
 954         floornum = (ret & 0x00ff);      /* lower 8 bits = floor number */
 955         flags = (ret & 0xff00); /* upper 8 bits = flags        */
 956
 957         if (flags & IR_MAILBOX) {
 958                 if (strncasecmp(Params[2].Key, "INBOX/", 6)) {
 959                         cprintf("%s NO Personal folders must be created under INBOX\r\n", Params[0].Key);
 960                         CtdlLogPrintf(CTDL_DEBUG, "not subordinate to inbox\n");
 961                         return;
 962                 }
 963         }
 964
 965         if (flags & IR_MAILBOX) {
 966                 newroomtype = 4;                /* private mailbox */
 967                 newroomview = VIEW_MAILBOX;
 968         } else {
 969                 newroomtype = 0;                /* public folder */
 970                 newroomview = VIEW_BBS;
 971         }
 972
 973         CtdlLogPrintf(CTDL_INFO, "Create new room <%s> on floor <%d> with type <%d>\n",
 974                 roomname, floornum, newroomtype);
 975
 976         ret = CtdlCreateRoom(roomname, newroomtype, "", floornum, 1, 0, newroomview);
 977         if (ret == 0) {
 978                 /*** DO NOT CHANGE THIS ERROR MESSAGE IN ANY WAY!  BYNARI CONNECTOR DEPENDS ON IT! ***/
 979                 cprintf("%s NO Mailbox already exists, or create failed\r\n", Params[0].Key);
 980         } else {
 981                 cprintf("%s OK CREATE completed\r\n", Params[0].Key);
 982                 /* post a message in Aide> describing the new room */
 983                 notification_message = malloc(1024);
 984                 snprintf(notification_message, 1024,
 985                         "A new room called \"%s\" has been created by %s%s%s%s\n",
 986                         roomname,
 987                         CC->user.fullname,
 988                         ((ret & QR_MAILBOX) ? " [personal]" : ""),
 989                         ((ret & QR_PRIVATE) ? " [private]" : ""),
 990                         ((ret & QR_GUESSNAME) ? " [hidden]" : "")
 991                 );
 992                 CtdlAideMessage(notification_message, "Room Creation Message");
 993                 free(notification_message);
 994         }
 995         CtdlLogPrintf(CTDL_DEBUG, "imap_create() completed\n");
 996 }
 997
 998
 999 /*
1000  * Locate a room by its IMAP folder name, and check access to it.
1001  * If zapped_ok is nonzero, we can also look for the room in the zapped list.
1002  */
1003 int imap_grabroom(char *returned_roomname, const char *foldername, int zapped_ok)
1004 {
1005         int ret;
1006         char augmented_roomname[ROOMNAMELEN];
1007         char roomname[ROOMNAMELEN];
1008         int c;
1009         struct ctdlroom QRscratch;
1010         int ra;
1011         int ok = 0;
1012
1013         ret = imap_roomname(roomname, sizeof roomname, foldername);
1014         if (ret < 0) {
1015                 return (1);
1016         }
1017
1018         /* First try a regular match */
1019         c = CtdlGetRoom(&QRscratch, roomname);
1020
1021         /* Then try a mailbox name match */
1022         if (c != 0) {
1023                 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname,
1024                             &CC->user, roomname);
1025                 c = CtdlGetRoom(&QRscratch, augmented_roomname);
1026                 if (c == 0)
1027                         strcpy(roomname, augmented_roomname);
1028         }
1029
1030         /* If the room exists, check security/access */
1031         if (c == 0) {
1032                 /* See if there is an existing user/room relationship */
1033                 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
1034
1035                 /* normal clients have to pass through security */
1036                 if (ra & UA_KNOWN) {
1037                         ok = 1;
1038                 }
1039                 if ((zapped_ok) && (ra & UA_ZAPPED)) {
1040                         ok = 1;
1041                 }
1042         }
1043
1044         /* Fail here if no such room */
1045         if (!ok) {
1046                 strcpy(returned_roomname, "");
1047                 return (2);
1048         } else {
1049                 strcpy(returned_roomname, QRscratch.QRname);
1050                 return (0);
1051         }
1052 }
1053
1054
1055 /*
1056  * Implements the STATUS command (sort of)
1057  *
1058  */
1059 void imap_status(int num_parms, ConstStr *Params)
1060 {
1061         int ret;
1062         char roomname[ROOMNAMELEN];
1063         char buf[SIZ];
1064         char savedroom[ROOMNAMELEN];
1065         int msgs, new;
1066
1067         ret = imap_grabroom(roomname, Params[2].Key, 1);
1068         if (ret != 0) {
1069                 cprintf
1070                     ("%s NO Invalid mailbox name or location, or access denied\r\n",
1071                      Params[0].Key);
1072                 return;
1073         }
1074
1075         /*
1076          * CtdlUserGoto() formally takes us to the desired room, happily returning
1077          * the number of messages and number of new messages.  (If another
1078          * folder is selected, save its name so we can return there!!!!!)
1079          */
1080         if (IMAP->selected) {
1081                 strcpy(savedroom, CC->room.QRname);
1082         }
1083         CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1084
1085         /*
1086          * Tell the client what it wants to know.  In fact, tell it *more* than
1087          * it wants to know.  We happily IGnore the supplied status data item
1088          * names and simply spew all possible data items.  It's far easier to
1089          * code and probably saves us some processing time too.
1090          */
1091         imap_mailboxname(buf, sizeof buf, &CC->room);
1092         cprintf("* STATUS ");
1093         plain_imap_strout(buf);
1094         cprintf(" (MESSAGES %d ", msgs);
1095         cprintf("RECENT %d ", new);     /* Initially, new==recent */
1096         cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
1097         cprintf("UNSEEN %d)\r\n", new);
1098
1099         /*
1100          * If another folder is selected, go back to that room so we can resume
1101          * our happy day without violent explosions.
1102          */
1103         if (IMAP->selected) {
1104                 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1105         }
1106
1107         /*
1108          * Oooh, look, we're done!
1109          */
1110         cprintf("%s OK STATUS completed\r\n", Params[0].Key);
1111 }
1112
1113
1114 /*
1115  * Implements the SUBSCRIBE command
1116  *
1117  */
1118 void imap_subscribe(int num_parms, ConstStr *Params)
1119 {
1120         int ret;
1121         char roomname[ROOMNAMELEN];
1122         char savedroom[ROOMNAMELEN];
1123         int msgs, new;
1124
1125         ret = imap_grabroom(roomname, Params[2].Key, 1);
1126         if (ret != 0) {
1127                 cprintf(
1128                         "%s NO Error %d: invalid mailbox name or location, or access denied\r\n",
1129                         Params[0].Key,
1130                         ret
1131                 );
1132                 return;
1133         }
1134
1135         /*
1136          * CtdlUserGoto() formally takes us to the desired room, which has the side
1137          * effect of marking the room as not-zapped ... exactly the effect
1138          * we're looking for.
1139          */
1140         if (IMAP->selected) {
1141                 strcpy(savedroom, CC->room.QRname);
1142         }
1143         CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1144
1145         /*
1146          * If another folder is selected, go back to that room so we can resume
1147          * our happy day without violent explosions.
1148          */
1149         if (IMAP->selected) {
1150                 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1151         }
1152
1153         cprintf("%s OK SUBSCRIBE completed\r\n", Params[0].Key);
1154 }
1155
1156
1157 /*
1158  * Implements the UNSUBSCRIBE command
1159  *
1160  */
1161 void imap_unsubscribe(int num_parms, ConstStr *Params)
1162 {
1163         int ret;
1164         char roomname[ROOMNAMELEN];
1165         char savedroom[ROOMNAMELEN];
1166         int msgs, new;
1167
1168         ret = imap_grabroom(roomname, Params[2].Key, 1);
1169         if (ret != 0) {
1170                 cprintf
1171                     ("%s NO Invalid mailbox name or location, or access denied\r\n",
1172                      Params[0].Key);
1173                 return;
1174         }
1175
1176         /*
1177          * CtdlUserGoto() formally takes us to the desired room.
1178          */
1179         if (IMAP->selected) {
1180                 strcpy(savedroom, CC->room.QRname);
1181         }
1182         CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1183
1184         /*
1185          * Now make the API call to zap the room
1186          */
1187         if (CtdlForgetThisRoom() == 0) {
1188                 cprintf("%s OK UNSUBSCRIBE completed\r\n", Params[0].Key);
1189         } else {
1190                 cprintf
1191                     ("%s NO You may not unsubscribe from this folder.\r\n",
1192                      Params[0].Key);
1193         }
1194
1195         /*
1196          * If another folder is selected, go back to that room so we can resume
1197          * our happy day without violent explosions.
1198          */
1199         if (IMAP->selected) {
1200                 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1201         }
1202 }
1203
1204
1205 /*
1206  * Implements the DELETE command
1207  *
1208  */
1209 void imap_delete(int num_parms, ConstStr *Params)
1210 {
1211         int ret;
1212         char roomname[ROOMNAMELEN];
1213         char savedroom[ROOMNAMELEN];
1214         int msgs, new;
1215
1216         ret = imap_grabroom(roomname, Params[2].Key, 1);
1217         if (ret != 0) {
1218                 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1219                         Params[0].Key);
1220                 return;
1221         }
1222
1223         /*
1224          * CtdlUserGoto() formally takes us to the desired room, happily returning
1225          * the number of messages and number of new messages.  (If another
1226          * folder is selected, save its name so we can return there!!!!!)
1227          */
1228         if (IMAP->selected) {
1229                 strcpy(savedroom, CC->room.QRname);
1230         }
1231         CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1232
1233         /*
1234          * Now delete the room.
1235          */
1236         if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1237                 CtdlScheduleRoomForDeletion(&CC->room);
1238                 cprintf("%s OK DELETE completed\r\n", Params[0].Key);
1239         } else {
1240                 cprintf("%s NO Can't delete this folder.\r\n", Params[0].Key);
1241         }
1242
1243         /*
1244          * If another folder is selected, go back to that room so we can resume
1245          * our happy day without violent explosions.
1246          */
1247         if (IMAP->selected) {
1248                 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1249         }
1250 }
1251
1252
1253 /*
1254  * Back end function for imap_rename()
1255  */
1256 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1257 {
1258         char foldername[SIZ];
1259         char newfoldername[SIZ];
1260         char newroomname[ROOMNAMELEN];
1261         int newfloor = 0;
1262         struct irl *irlp = NULL;        /* scratch pointer */
1263         struct irlparms *irlparms;
1264
1265         irlparms = (struct irlparms *) data;
1266         imap_mailboxname(foldername, sizeof foldername, qrbuf);
1267
1268         /* Rename subfolders */
1269         if ((!strncasecmp(foldername, irlparms->oldname,
1270                           strlen(irlparms->oldname))
1271              && (foldername[strlen(irlparms->oldname)] == '/'))) {
1272
1273                 sprintf(newfoldername, "%s/%s",
1274                         irlparms->newname,
1275                         &foldername[strlen(irlparms->oldname) + 1]
1276                     );
1277
1278                 newfloor = imap_roomname(newroomname,
1279                                          sizeof newroomname,
1280                                          newfoldername) & 0xFF;
1281
1282                 irlp = (struct irl *) malloc(sizeof(struct irl));
1283                 strcpy(irlp->irl_newroom, newroomname);
1284                 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1285                 irlp->irl_newfloor = newfloor;
1286                 irlp->next = *(irlparms->irl);
1287                 *(irlparms->irl) = irlp;
1288         }
1289 }
1290
1291
1292 /*
1293  * Implements the RENAME command
1294  *
1295  */
1296 void imap_rename(int num_parms, ConstStr *Params)
1297 {
1298         char old_room[ROOMNAMELEN];
1299         char new_room[ROOMNAMELEN];
1300         int oldr, newr;
1301         int new_floor;
1302         int r;
1303         struct irl *irl = NULL; /* the list */
1304         struct irl *irlp = NULL;        /* scratch pointer */
1305         struct irlparms irlparms;
1306         char buf[1024];
1307
1308         if (strchr(Params[3].Key, '\\') != NULL) {
1309                 cprintf("%s NO Invalid character in folder name\r\n",
1310                         Params[0].Key);
1311                 return;
1312         }
1313
1314         oldr = imap_roomname(old_room, sizeof old_room, Params[2].Key);
1315         newr = imap_roomname(new_room, sizeof new_room, Params[3].Key);
1316         new_floor = (newr & 0xFF);
1317
1318         r = CtdlRenameRoom(old_room, new_room, new_floor);
1319
1320         if (r == crr_room_not_found) {
1321                 cprintf("%s NO Could not locate this folder\r\n",
1322                         Params[0].Key);
1323                 return;
1324         }
1325         if (r == crr_already_exists) {
1326                 cprintf("%s NO '%s' already exists.\r\n", Params[0].Key, Params[2].Key);
1327                 return;
1328         }
1329         if (r == crr_noneditable) {
1330                 cprintf("%s NO This folder is not editable.\r\n", Params[0].Key);
1331                 return;
1332         }
1333         if (r == crr_invalid_floor) {
1334                 cprintf("%s NO Folder root does not exist.\r\n", Params[0].Key);
1335                 return;
1336         }
1337         if (r == crr_access_denied) {
1338                 cprintf("%s NO You do not have permission to edit this folder.\r\n",
1339                         Params[0].Key);
1340                 return;
1341         }
1342         if (r != crr_ok) {
1343                 cprintf("%s NO Rename failed - undefined error %d\r\n",
1344                         Params[0].Key, r);
1345                 return;
1346         }
1347
1348         /* If this is the INBOX, then RFC2060 says we have to just move the
1349          * contents.  In a Citadel environment it's easier to rename the room
1350          * (already did that) and create a new inbox.
1351          */
1352         if (!strcasecmp(Params[2].Key, "INBOX")) {
1353                 CtdlCreateRoom(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1354         }
1355
1356         /* Otherwise, do the subfolders.  Build a list of rooms to rename... */
1357         else {
1358                 irlparms.oldname = Params[2].Key;
1359                 irlparms.newname = Params[3].Key;
1360                 irlparms.irl = &irl;
1361                 CtdlForEachRoom(imap_rename_backend, (void *) &irlparms);
1362
1363                 /* ... and now rename them. */
1364                 while (irl != NULL) {
1365                         r = CtdlRenameRoom(irl->irl_oldroom,
1366                                            irl->irl_newroom,
1367                                            irl->irl_newfloor);
1368                         if (r != crr_ok) {
1369                                 /* FIXME handle error returns better */
1370                                 CtdlLogPrintf(CTDL_ERR, "CtdlRenameRoom() error %d\n", r);
1371                         }
1372                         irlp = irl;
1373                         irl = irl->next;
1374                         free(irlp);
1375                 }
1376         }
1377
1378         snprintf(buf, sizeof buf, "IMAP folder \"%s\" renamed to \"%s\" by %s\n",
1379                 Params[2].Key,
1380                 Params[3].Key,
1381                 CC->curr_user
1382         );
1383         CtdlAideMessage(buf, "IMAP folder rename");
1384
1385         cprintf("%s OK RENAME completed\r\n", Params[0].Key);
1386 }
1387
1388
1389 /*
1390  * Main command loop for IMAP sessions.
1391  */
1392 void imap_command_loop(void)
1393 {
1394         struct timeval tv1, tv2;
1395         suseconds_t total_time = 0;
1396         int untagged_ok = 1;
1397         citimap *Imap;
1398         const char *pchs, *pche;
1399
1400         gettimeofday(&tv1, NULL);
1401         CC->lastcmd = time(NULL);
1402         Imap = IMAP;
1403
1404         flush_output();
1405         if (Imap->Cmd.CmdBuf == NULL)
1406                 Imap->Cmd.CmdBuf = NewStrBufPlain(NULL, SIZ);
1407         else
1408                 FlushStrBuf(Imap->Cmd.CmdBuf);
1409
1410         if (CtdlClientGetLine(Imap->Cmd.CmdBuf) < 1) {
1411                 CtdlLogPrintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
1412                 CC->kill_me = 1;
1413                 return;
1414         }
1415
1416         if (Imap->authstate == imap_as_expecting_password) {
1417                 CtdlLogPrintf(CTDL_INFO, "IMAP: <password>\n");
1418         }
1419         else if (Imap->authstate == imap_as_expecting_plainauth) {
1420                 CtdlLogPrintf(CTDL_INFO, "IMAP: <plain_auth>\n");
1421         }
1422         else if ((Imap->authstate == imap_as_expecting_multilineusername) ||
1423                  bmstrcasestr(ChrPtr(Imap->Cmd.CmdBuf), " LOGIN ")) {
1424                 CtdlLogPrintf(CTDL_INFO, "IMAP: LOGIN...\n");
1425         }
1426         else {
1427                 CtdlLogPrintf(CTDL_INFO, "IMAP: %s\n", ChrPtr(Imap->Cmd.CmdBuf));
1428         }
1429
1430         pchs = ChrPtr(Imap->Cmd.CmdBuf);
1431         pche = pchs + StrLength(Imap->Cmd.CmdBuf);
1432
1433         while ((pche > pchs) &&
1434                ((*pche == '\n') ||
1435                 (*pche == '\r')))
1436         {
1437                 pche --;
1438                 StrBufCutRight(Imap->Cmd.CmdBuf, 1);
1439         }
1440         StrBufTrim(Imap->Cmd.CmdBuf);
1441
1442         /* If we're in the middle of a multi-line command, handle that */
1443         switch (Imap->authstate){
1444         case imap_as_expecting_username:
1445                 imap_auth_login_user(imap_as_expecting_username);
1446                 return;
1447         case imap_as_expecting_multilineusername:
1448                 imap_auth_login_user(imap_as_expecting_multilineusername);
1449                 return;
1450         case imap_as_expecting_plainauth:
1451                 imap_auth_plain();
1452                 return;
1453         case imap_as_expecting_password:
1454                 imap_auth_login_pass(imap_as_expecting_password);
1455                 return;
1456         case imap_as_expecting_multilinepassword:
1457                 imap_auth_login_pass(imap_as_expecting_multilinepassword);
1458                 return;
1459         default:
1460                 break;
1461         }
1462
1463
1464         /* Ok, at this point we're in normal command mode.
1465          * If the command just submitted does not contain a literal, we
1466          * might think about delivering some untagged stuff...
1467          */
1468         if (*(ChrPtr(Imap->Cmd.CmdBuf) + StrLength(Imap->Cmd.CmdBuf) - 1)
1469             == '}') {
1470                 untagged_ok = 0;
1471         }
1472
1473         /* Grab the tag, command, and parameters. */
1474         imap_parameterize(&Imap->Cmd);
1475 #if 0
1476 /* debug output the parsed vector */
1477         {
1478                 int i;
1479                 CtdlLogPrintf(CTDL_DEBUG, "----- %ld params \n",
1480                               Imap->Cmd.num_parms);
1481
1482         for (i=0; i < Imap->Cmd.num_parms; i++) {
1483                 if (Imap->Cmd.Params[i].len != strlen(Imap->Cmd.Params[i].Key))
1484                         CtdlLogPrintf(CTDL_DEBUG, "*********** %ld != %ld : %s\n",
1485                                       Imap->Cmd.Params[i].len,
1486                                       strlen(Imap->Cmd.Params[i].Key),
1487                                       Imap->Cmd.Params[i].Key);
1488                 else
1489                         CtdlLogPrintf(CTDL_DEBUG, "%ld : %s\n",
1490                                       Imap->Cmd.Params[i].len,
1491                                       Imap->Cmd.Params[i].Key);
1492         }}
1493
1494 #endif
1495         /* RFC3501 says that we cannot output untagged data during these commands */
1496         if (Imap->Cmd.num_parms >= 2) {
1497                 if (  (!strcasecmp(Imap->Cmd.Params[1].Key, "FETCH"))
1498                    || (!strcasecmp(Imap->Cmd.Params[1].Key, "STORE"))
1499                    || (!strcasecmp(Imap->Cmd.Params[1].Key, "SEARCH"))
1500                 ) {
1501                         untagged_ok = 0;
1502                 }
1503         }
1504
1505         if (untagged_ok) {
1506
1507                 /* we can put any additional untagged stuff right here in the future */
1508
1509                 /*
1510                  * Before processing the command that was just entered... if we happen
1511                  * to have a folder selected, we'd like to rescan that folder for new
1512                  * messages, and for deletions/changes of existing messages.  This
1513                  * could probably be optimized better with some deep thought...
1514                  */
1515                 if (Imap->selected) {
1516                         imap_rescan_msgids();
1517                 }
1518         }
1519
1520         /* Now for the command set. */
1521
1522         if (Imap->Cmd.num_parms < 2) {
1523                 cprintf("BAD syntax error\r\n");
1524         }
1525
1526         /* The commands below may be executed in any state */
1527
1528         else if ((!strcasecmp(Imap->Cmd.Params[1].Key, "NOOP"))
1529                  || (!strcasecmp(Imap->Cmd.Params[1].Key, "CHECK"))) {
1530                 cprintf("%s OK No operation\r\n",
1531                         Imap->Cmd.Params[0].Key);
1532         }
1533
1534         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "ID")) {
1535                 imap_id(Imap->Cmd.num_parms, Imap->Cmd.Params);
1536         }
1537
1538
1539         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "LOGOUT")) {
1540                 if (Imap->selected) {
1541                         imap_do_expunge();      /* yes, we auto-expunge at logout */
1542                 }
1543                 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1544                 cprintf("%s OK Citadel IMAP session ended.\r\n",
1545                         Imap->Cmd.Params[0].Key);
1546                 CC->kill_me = 1;
1547                 return;
1548         }
1549
1550         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "LOGIN")) {
1551                 imap_login(Imap->Cmd.num_parms, Imap->Cmd.Params);
1552         }
1553
1554         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "AUTHENTICATE")) {
1555                 imap_authenticate(Imap->Cmd.num_parms, Imap->Cmd.Params);
1556         }
1557
1558         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "CAPABILITY")) {
1559                 imap_capability(Imap->Cmd.num_parms, Imap->Cmd.Params);
1560         }
1561 #ifdef HAVE_OPENSSL
1562         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "STARTTLS")) {
1563                 imap_starttls(Imap->Cmd.num_parms, Imap->Cmd.Params);
1564         }
1565 #endif
1566         else if (!CC->logged_in) {
1567                 cprintf("%s BAD Not logged in.\r\n", Imap->Cmd.Params[0].Key);
1568         }
1569
1570         /* The commans below require a logged-in state */
1571
1572         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "SELECT")) {
1573                 imap_select(Imap->Cmd.num_parms, Imap->Cmd.Params);
1574         }
1575
1576         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "EXAMINE")) {
1577                 imap_select(Imap->Cmd.num_parms, Imap->Cmd.Params);
1578         }
1579
1580         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "LSUB")) {
1581                 imap_list(Imap->Cmd.num_parms, Imap->Cmd.Params);
1582         }
1583
1584         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "LIST")) {
1585                 imap_list(Imap->Cmd.num_parms, Imap->Cmd.Params);
1586         }
1587
1588         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "CREATE")) {
1589                 imap_create(Imap->Cmd.num_parms, Imap->Cmd.Params);
1590         }
1591
1592         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "DELETE")) {
1593                 imap_delete(Imap->Cmd.num_parms, Imap->Cmd.Params);
1594         }
1595
1596         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "RENAME")) {
1597                 imap_rename(Imap->Cmd.num_parms, Imap->Cmd.Params);
1598         }
1599
1600         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "STATUS")) {
1601                 imap_status(Imap->Cmd.num_parms, Imap->Cmd.Params);
1602         }
1603
1604         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "SUBSCRIBE")) {
1605                 imap_subscribe(Imap->Cmd.num_parms, Imap->Cmd.Params);
1606         }
1607
1608         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "UNSUBSCRIBE")) {
1609                 imap_unsubscribe(Imap->Cmd.num_parms, Imap->Cmd.Params);
1610         }
1611
1612         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "APPEND")) {
1613                 imap_append(Imap->Cmd.num_parms, Imap->Cmd.Params);
1614         }
1615
1616         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "NAMESPACE")) {
1617                 imap_namespace(Imap->Cmd.num_parms, Imap->Cmd.Params);
1618         }
1619
1620         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "SETACL")) {
1621                 imap_setacl(Imap->Cmd.num_parms, Imap->Cmd.Params);
1622         }
1623
1624         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "DELETEACL")) {
1625                 imap_deleteacl(Imap->Cmd.num_parms, Imap->Cmd.Params);
1626         }
1627
1628         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "GETACL")) {
1629                 imap_getacl(Imap->Cmd.num_parms, Imap->Cmd.Params);
1630         }
1631
1632         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "LISTRIGHTS")) {
1633                 imap_listrights(Imap->Cmd.num_parms, Imap->Cmd.Params);
1634         }
1635
1636         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "MYRIGHTS")) {
1637                 imap_myrights(Imap->Cmd.num_parms, Imap->Cmd.Params);
1638         }
1639
1640         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "GETMETADATA")) {
1641                 imap_getmetadata(Imap->Cmd.num_parms, Imap->Cmd.Params);
1642         }
1643
1644         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "SETMETADATA")) {
1645                 imap_setmetadata(Imap->Cmd.num_parms, Imap->Cmd.Params);
1646         }
1647
1648         else if (Imap->selected == 0) {
1649                 cprintf("%s BAD no folder selected\r\n", Imap->Cmd.Params[0].Key);
1650         }
1651
1652         /* The commands below require the SELECT state on a mailbox */
1653
1654         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "FETCH")) {
1655                 imap_fetch(Imap->Cmd.num_parms, Imap->Cmd.Params);
1656         }
1657
1658         else if ((!strcasecmp(Imap->Cmd.Params[1].Key, "UID"))
1659                  && (!strcasecmp(Imap->Cmd.Params[2].Key, "FETCH"))) {
1660                 imap_uidfetch(Imap->Cmd.num_parms, Imap->Cmd.Params);
1661         }
1662
1663         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "SEARCH")) {
1664                 imap_search(Imap->Cmd.num_parms, Imap->Cmd.Params);
1665         }
1666
1667         else if ((!strcasecmp(Imap->Cmd.Params[1].Key, "UID"))
1668                  && (!strcasecmp(Imap->Cmd.Params[2].Key, "SEARCH"))) {
1669                 imap_uidsearch(Imap->Cmd.num_parms, Imap->Cmd.Params);
1670         }
1671
1672         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "STORE")) {
1673                 imap_store(Imap->Cmd.num_parms, Imap->Cmd.Params);
1674         }
1675
1676         else if ((!strcasecmp(Imap->Cmd.Params[1].Key, "UID"))
1677                  && (!strcasecmp(Imap->Cmd.Params[2].Key, "STORE"))) {
1678                 imap_uidstore(Imap->Cmd.num_parms, Imap->Cmd.Params);
1679         }
1680
1681         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "COPY")) {
1682                 imap_copy(Imap->Cmd.num_parms, Imap->Cmd.Params);
1683         }
1684
1685         else if ((!strcasecmp(Imap->Cmd.Params[1].Key, "UID")) && (!strcasecmp(Imap->Cmd.Params[2].Key, "COPY"))) {
1686                 imap_uidcopy(Imap->Cmd.num_parms, Imap->Cmd.Params);
1687         }
1688
1689         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "EXPUNGE")) {
1690                 imap_expunge(Imap->Cmd.num_parms, Imap->Cmd.Params);
1691         }
1692
1693         else if ((!strcasecmp(Imap->Cmd.Params[1].Key, "UID")) && (!strcasecmp(Imap->Cmd.Params[2].Key, "EXPUNGE"))) {
1694                 imap_expunge(Imap->Cmd.num_parms, Imap->Cmd.Params);
1695         }
1696
1697         else if (!strcasecmp(Imap->Cmd.Params[1].Key, "CLOSE")) {
1698                 imap_close(Imap->Cmd.num_parms, Imap->Cmd.Params);
1699         }
1700
1701         /* End of commands.  If we get here, the command is either invalid
1702          * or unimplemented.
1703          */
1704
1705         else {
1706                 cprintf("%s BAD command unrecognized\r\n", Imap->Cmd.Params[0].Key);
1707         }
1708
1709         /* If the client transmitted a message we can free it now */
1710         imap_free_transmitted_message();
1711
1712         gettimeofday(&tv2, NULL);
1713         total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1714         CtdlLogPrintf(CTDL_DEBUG, "IMAP command completed in %ld.%ld seconds\n",
1715                 (total_time / 1000000),
1716                 (total_time % 1000000)
1717         );
1718 }
1719
1720
1721 const char *CitadelServiceIMAP="IMAP";
1722 const char *CitadelServiceIMAPS="IMAPS";
1723
1724 /*
1725  * This function is called to register the IMAP extension with Citadel.
1726  */
1727 CTDL_MODULE_INIT(imap)
1728 {
1729         if (!threading)
1730         {
1731                 CtdlRegisterServiceHook(config.c_imap_port,
1732                                         NULL, imap_greeting, imap_command_loop, NULL, CitadelServiceIMAP);
1733 #ifdef HAVE_OPENSSL
1734                 CtdlRegisterServiceHook(config.c_imaps_port,
1735                                         NULL, imaps_greeting, imap_command_loop, NULL, CitadelServiceIMAPS);
1736 #endif
1737                 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);
1738         }
1739
1740         /* return our Subversion id for the Log */
1741         return "$Id$";
1742 }